Exporting Report (CSV)

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows retrieval of SMS, Email, Push notification, WhatsApp, RCS records sent over a specific period.

📘

NOTE

  • The generated report contains the logs of sent messages and will be sent directly to one or more email addresses in CSV format.
  • The max date range you can get the logs is 92 days.
  • If you set the date range more than 92 days, from the response body the parameter "explain" will display the next message: "The date range exceeds the allowed limit: 92"
  • If the size of the report which contains the records is too big, from the response body the parameter "explain" will display the next message: "The size of the report is too big. Please contact support"

Statistics over an extended period could have a large number of logs. To make requests more responsive, we provide consistent filters and pagination as shown in the query params:

For more information how to export the report, go to the Exporting Report (CSV) section.

Query Params
string
required

The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the Start of the reporting period.

For example: '2015-03-04T00:00:00.000Z'

string
required

The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the End of the reporting period.

This must be after the start period time you defined in the 'from' parameter.

For example: '2015-03-04T00:00:00.000Z'

string

Enter the recipient's phone number or email address according to the delivery channel the message was sent to.

For SMS, WhatsApp or RCS, you need to provide the phone number of the recipient.

For Email, you need to provide the email address of the recipient.

string

Unique identifier of the campaign.

string

Delivery channel from which the message was sent.

  • 'S': SMS
  • 'E': Email
  • 'P': Push notification
  • 'W': WhatsApp
  • 'R': RCS

NOTE: You can only filter by one channel. That is, you cannot get logs from two or more delivery channels in the same request.

string

Enter the sending identity (Sender) according to the delivery channel.

string

Status of the message.

Each delivery channel has its own message status.

NOTE: To filter by more than 1 status, enter each status separated by comma (without spaces). For example: SENT,EXPIRED

Body Params
emails
array of strings
required

List (array) of recipient emails where the CSV file will be sent.

emails*
string
required

Email address of the sender.

NOTE: The Sender must be a valid sender from the space.

string
required

Timezone in GMT.

string

Alphanumeric identifier that can be used for reporting purposes.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Español (América Latina)
Powered by Localize
English