Retrieves SMS campaign activity metrics.

Returns campaigns with activity in the requested date range, with metrics for that activity only.

Sort order

Results are always returned in this fixed order:

  1. dateSent, newest first.
  2. campaignId, highest first, when two or more campaigns have the same dateSent.

You cannot change this order. The sort parameter is not supported.

Notes

  • Dates are calendar dates (yyyy-MM-dd) in your account's time zone. Both dates are inclusive.
  • The range cannot include future dates or span more than 730 days.
  • Standard and automated SMS, MMS and RCS campaigns are included, with channel metrics combined per campaign.
  • Daily unique-click and conversion counts are summed, not deduplicated across the range. A contact that clicks or converts on more than one day counts once for each day.
  • Revenue values are in your account's currency. Percentage values are from 0 to 100.
  • Filters are not supported in this version.
  • The next link is only returned when another page exists.
Query Params
date
required
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

First calendar day of the range, in your account's time zone (yyyy-MM-dd), for example 2024-01-01. Do not include a time or UTC offset.

date
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

Last calendar day of the range, in your account's time zone (yyyy-MM-dd), for example 2024-01-31. Defaults to today.

int32
1 to 5000

Maximum number of records to retrieve per page

string

Pagination marker to retrieve the data from

Headers
uuid

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json