Exporting Report (CSV)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You use this endpoint to retrieve SMS, Email, WhatsApp, and RCS records sent over a specific period.

📘

NOTE

  • The generated report contains the logs of sent messages. It is sent directly to one or more email addresses in CSV format.
  • You can get logs for a maximum date range of 92 days.
  • If you set the date range to more than 92 days, the "explain" parameter in the response body displays this message: "The date range exceeds the allowed limit: 92"
  • If the report containing the records is too big, the "explain" parameter in the response body displays this message: "The size of the report is too big. Please contact support"

You may generate a large number of logs when requesting statistics over an extended period. Consistent filters and pagination, shown in the query params, keep these requests responsive.

You can find more information on how to export the report in 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 broadcast.

string

Delivery channel from which the message was sent.

  • 'S': SMS
  • 'E': Email
  • '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, unique
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 Workspace.

string
required

Timezone in GMT.

string

Alphanumeric identifier that can be used for reporting purposes.

Responses

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