How to get KPIs and metrics from the Omnisend API
In this article we will explain how we get your metrics data from Omnisend to display in MinimalDashboard, but if you want to use this data in your own application you can either use our API or follow the instructions below to write your own implementation.
Omnisend is an eCommerce email and SMS marketing platform, providing automation, segmentation, and multi-channel campaigns to increase sales with a modern API giving you access to your contacts data. You can find their documentation here: Omnisend's API.
Contents
Authentication
Omnisend’s API support authentication via the X-API-Key header. Use the API token available from your integrations page as the header value.
Endpoint
The primary endpoint to get all contact in your account is:
https://api.omnisend.com/v5/contacts
You currently can’t get historic data for contacts.
How to get your active subscribers count from Omnisend
To get all contacts send a GET request to and specify the status:
https://api.omnisend.com/v5/contacts
?status=subscribed
This will return a list of contacts:
{
"contacts": [
{
"email": "...",
"contactID": "...",
"createdAt": "...",
},
...
],
"paging": {
"next": "...",
}
}
Page through the results by contiuously using the paging.next url until it is null.
The sum of all objects is your active subscriber count.
Looking for more?
Have a look at our API knowledge base with many more services...
Omnisend
Email Marketing
If you'd like to have a ready-made dashboard with all the metrics from Omnisend instead, you can create one with MinimalDashboard in a few clicks.
Create dashboards to show
- Active Subscriber Count
- Unsubscriber Count
- Total Subscriber Count