Retrieve monthly stats for all subusers
GET {{baseUrl}}/subusers/stats/monthly?date=<string>&subuser=<string>&sort_by_metric=<string>&sort_by_direction=<string>&limit=<string>&offset=<string>
This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range.
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats for your subusers. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
When using the sort_by_metric
to sort your stats by a
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
date | string | The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD | |
subuser | string | The subuser you are requesting for. | |
sort_by_metric | string | The metric that you want to sort by. Metrics that you can sort by are: blocks , bounces , clicks , delivered , opens , requests , unique_clicks , unique_opens , and unsubscribes .' | |
sort_by_direction | string | The direction to sort the results. | |
limit | string | The number of results to include on each page. | |
offset | string | The number of results to exclude. |