GET an SMS Campaigns Summary Report
Use this method to get SMS campaign summary details, including the total number of times that each contact uniquely interacted with each tracked campaign activity and aggregate tracking statistics. Results are sorted in descending order by the date the SMS was last sent (last_sent_date). The start_at date is required. Use both the start_at and end_at date query parameters to return only SMS campaign summary details that occurred within a specified date range. Use the limit query parameter to limit the number of results returned per page.
Query parameters
Use to limit the number of results to return on a single page (from 1 to 50). The default setting is 50.
Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or after the required start_at date you specify. ISO 8601 format.
Use to limit the results to include SMS campaign summary details for SMS campaigns sent on or before the end_at date you specify. ISO 8601 format.
Response
Request was successful.
Example response
{
"bulk_sms_campaign_summaries": [
{
"campaign_id": "a2fdc285-f4bc-408c-9e64-f3f89038ec82",
"campaign_name": "Spring Clearance Sale",
"last_sent_date": "2019-04-25T11:08:00.000Z",
"unique_counts": {
"sends": 100,
"delivers": 100,
"opens": 75,
"clicks": 294
},
"campaign_type": "SMS"
}
],
"aggregate_percents": {
"deliver": 23,
"click": 43
}
}