Skip to navigation
Transactional SMSSMS statistics

Get all your SMS activity (unaggregated events)

View as Markdown

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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Query parameters

limitlongOptional0-100Defaults to 50
Number of documents per page
startDatestringOptional

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

endDatestringOptional

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

offsetlongOptionalDefaults to 0
Index of the first document of the page
dayslongOptional

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

phoneNumberstringOptional
Filter the report for a specific phone number
eventenumOptional
Filter the report for specific events
tagsstringOptional
Filter the report for specific tags passed as a serialized urlencoded array
sortenumOptionalDefaults to desc

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

Allowed values:

Response

Sms events report informations
eventslist of objectsOptional

Errors

400
Bad Request Error