Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
MLog report

Exporting Report (CSV)

post/v3/mlog

Query parameters

fromstring required
<p>The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the <b>Start</b> of the reporting period.</p> <p>For example: '2015-03-04T00:00:00.000Z'</p>
tostring required
<p>The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the <b>End</b> of the reporting period.</p> <p>This must be after the start period time you defined in the <code>'from'</code> parameter.</p> <p>For example: '2015-03-04T00:00:00.000Z'</p>
recipientstring
<p>Enter the recipient's phone number or email address according to the delivery channel the message was sent to.</p> <p>For SMS, WhatsApp or RCS, you need to provide the phone number of the recipient.</p> <p>For Email, you need to provide the email address of the recipient.</p>
campaignIDstring

Unique identifier of the broadcast.

channelstring
<p>Delivery channel from which the message was sent.</p> <p><ul><li><code>'S'</code>: SMS</li> <li><code>'E'</code>: Email</li><li><code>'W'</code>: WhatsApp</li> <li><code>'R'</code>: RCS</li></ul></p> <p><b>NOTE</b>: You can only filter by one channel. That is, you cannot get logs from two or more delivery channels in the same request.</p>
senderstring

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

statusstring
<p>Status of the message.</p> <p>Each delivery channel has its own message status.</p> <p><b>NOTE</b>: To filter by more than 1 status, enter each status separated by comma (without spaces). For example: <code>SENT,EXPIRED</code></p>

Request body

emailsstring[] required

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

fromstring required
<p>Email address of the sender.</p> <p><b>NOTE</b>: The Sender must be a valid sender from the Workspace.</p>
timezonestring required

Timezone in GMT.

externalIdstring

Alphanumeric identifier that can be used for reporting purposes.

Example request

{
  "emails": [
    "successdemo1@simulator.amazonses.com",
    "successdemo2@simulator.amazonses.com"
  ],
  "from": "example@domain.com",
  "timezone": "GMT-0400",
  "externalId": "11401"
}

Response

Report request received successfully

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}