Fetch Summary Stats
Changed onThis API tracks key events—such as opens, clicks, and unsubscribes— and generates performance statistics, updated hourly based on your profile’s timezone. You can view this data in your Email API dashboard or retrieve it programmatically via this API. Retention Policy: - Monthly stats are retained for the lifetime of the domain. - Event-level data is retained for 90 days.
Request
- Base URLhttps://emailapi.netcorecloud.net/v6
- URLhttps://emailapi.netcorecloud.net/v6/stats
- AuthHTTP bearer
Query parameters
The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
How to group the statistics. Must be one of: day, week, month, tag, fromdomain, recipientdomain, fromaddress, subaccount.
Headers
When a master account API key is used you can fetch the summary stats of the subaccount by providing subaccount username.
Response
OK
Example response
{
"data": [
{
"date": "string",
"stats": [
{
"metrics": {
"bounce": 0,
"click": 0,
"dropped": 0,
"invalid": 0,
"open": 0,
"sent": 0,
"spam": 0,
"unique_click": 0,
"unique_open": 0,
"unsub": 0,
"processed": 0
}
}
]
}
]
}Changes
- breaking
for the
queryrequest parameteraggregated_by, default valuedaywas added - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - breaking
the
/////response's property type changed fromstringtonumberfor status - warning
deleted the
headerrequest parameterapi_key - warning
deleted the
queryrequest parameterenddate - warning
deleted the
queryrequest parameterlimit - warning
deleted the
queryrequest parameteroffset - warning
deleted the
queryrequest parameterstartdate - warning
removed the optional property
from the response with the status - info
api operation id
GET_statsremoved and replaced withget-stats - info
the endpoint scheme security
bearerwas added to the API - info
api tag
Stats APIadded - info
api tag
Events APIremoved - info
added the new optional
headerrequest parameteron-behalf-of - info
added the new optional
queryrequest parameterend_date - info
added the new optional
queryrequest parameterstart_date - info
added the new enum value
fromaddressto thequeryrequest parameteraggregated_by - info
added the new enum value
fromdomainto thequeryrequest parameteraggregated_by - info
added the new enum value
recipientdomainto thequeryrequest parameteraggregated_by - info
added the new enum value
subaccountto thequeryrequest parameteraggregated_by - info
added the new enum value
tagto thequeryrequest parameteraggregated_by - info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
added the optional property
/////to the response with the status
- breaking