Getting Report (JSON)

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

This endpoint allows the retrieval of SMS, Email, WhatsApp, and RCS records sent over a specific period via JSON body.

📘

NOTE

  • 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"
  • We recommend set the "pretty" query param in true

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 following query params:

For more information on how to get the report, go to the Getting Report (JSON) 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

int32

Use limit operator to limit the number of records returned

int32

Use skip operator to skip the specified number of records.

boolean

User-readable values

  • true: Set the value parameter in true to return a response with user-readable values.
  • false: Set the value parameter in false to return a response with non-user-readable values.

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