transactionalSms

Get your SMS activity aggregated per day

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.

get/transactionalSMS/statistics/reports

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/transactionalSMS/statistics/reports
  • Auth: API key in header api-key

Query parameters

startDatestring

Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report

endDatestring

Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report

daysinteger

Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

tagstring

Filter on a tag

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Response

Aggregated SMS report informations

Changes

No recorded changes to this operation across all 1 revision of this API.