GET /transactionalSMS/statistics/aggregatedReport

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.

Servers

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

startDate String No

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

tag String No

Filter on a tag

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.