GET /transactionalSMS/statistics/reports
Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using startDate and endDate (both required together, YYYY-MM-DD format), by a number of past days (not compatible with date range), or by tag. Results are sorted in descending order by default unless overridden with the sort parameter.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report |
days |
Integer | No |
Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' |
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
startDate |
String | No |
Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report |
tag |
String | No |
Filter on a tag |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.