Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]
GET {{baseUrl}}/categories/stats/sums?sort_by_metric=<string>&sort_by_direction=<string>&start_date=<string>&end_date=<string>&limit=<string>&offset=<string>&aggregated_by=<string>
This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.
If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
Categories allow you to group your emails together according to broad topics that you define. For more information, please see our User Guide.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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. | |
start_date | string | The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD. | |
end_date | string | The end date of the statistics to retrieve. Defaults to today. | |
limit | string | The number of results to include on each page. | |
offset | string | The number of results to exclude. | |
aggregated_by | string | How to group the stats. Must be either "day", "week", or "month". |