Retrieve Email Statistics for Categories
GET {{baseUrl}}/categories/stats?start_date=<string>&end_date=<string>&categories=<string>&limit=<string>&offset=<string>&aggregated_by=<string>
This endpoint allows you to retrieve all of your email statistics for each of your categories.
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 |
---|---|---|---|
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. | |
categories | string | The individual categories that you want to retrieve statistics for. You may include up to 10 different categories. | |
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". |