GET /transactionalSMS/statistics/events
Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden. Filter by date range (startDate/endDate), past days (not compatible with date range), specific event type (e.g. delivered, bounces, replies), phoneNumber, or tags. Bounce events include the failure reason, and reply events include the reply content.
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' |
limit |
Integer | No |
Number of documents per page Default value: 50 |
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
phoneNumber |
String | No |
Filter the report for a specific phone number |
tags |
String | No |
Filter the report for specific tags passed as a serialized urlencoded array |
event |
String | No |
Filter the report for specific events Valid values:
|
startDate |
String | No |
Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report |
offset |
Integer | No |
Index of the first document of the page Default value: 0 |
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.