Transactional SMSSMS statistics

Get your SMS activity aggregated over a period of time

Authentication

api-keystring

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

Query parameters

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

dayslongOptional

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

tagstringOptional
Filter on a tag

Response

Aggregated SMS report informations
acceptedlong or null
Number of accepted SMS for the timeframe
blockedlong or null
Number of blocked contact for the timeframe
deliveredlong or null
Number of delivered SMS for the timeframe
hardBounceslong or null
Number of hardbounces for the timeframe
rangestring or null
Time frame of the report
rejectedlong or null
Number of rejected SMS for the timeframe
repliedlong or null
Number of answered SMS for the timeframe
requestslong or null
Number of requests for the timeframe
skippedlong or null
Number of skipped SMS for the timeframe
softBounceslong or null
Number of softbounces for the timeframe
unsubscribedlong or null
Number of unsubscription for the timeframe

Errors