Body

events

Required

Type string

Description

Specifies the types of events related to notifications to retrieve.

Guidance

Options:

  • "sent" — retrieves all devices sent the specified message identified by their Subscription ID. sent events are not recorded for messages targeting fewer than 1,000 recipients.
  • "clicked"— retrieves all devices that interacted with the message identified by their Subscription ID. Note that there isn't a recipient count threshold for tracking clicked events.

Example

{
  "events": "clicked"
}

email

Type string

Description

The email address in which to deliver the report.

Guidance

Ensure that the provided email address is valid and actively monitored; once completed, we will send the report.

Example

{
  "email": "[email protected]"
}