transactionalSms

Get your SMS activity aggregated over a period of time

Retrieve an aggregated report of your transactional SMS activity over a specified time period, including 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) or by a number of past days (not compatible with date range). You can further narrow results by tag. If no date filter is provided, the report covers all available data and returns the auto-detected date range.

get/transactionalSMS/statistics/aggregatedReport

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/transactionalSMS/statistics/aggregatedReport
  • 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

Response

Aggregated SMS report informations

acceptedinteger

Number of accepted SMS for the timeframe

blockedinteger

Number of blocked contact for the timeframe

deliveredinteger

Number of delivered SMS for the timeframe

hardBouncesinteger

Number of hardbounces for the timeframe

rangestring

Time frame of the report

rejectedinteger

Number of rejected SMS for the timeframe

repliedinteger

Number of answered SMS for the timeframe

requestsinteger

Number of requests for the timeframe

skippedinteger

Number of skipped SMS for the timeframe

softBouncesinteger

Number of softbounces for the timeframe

unsubscribedinteger

Number of unsubscription for the timeframe

Changes

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