get

/transactional/email

GetTransactionalEmailReport function gets the report of transactional email messages by mainly transactionId or the report of a number of transactional email messages by groupId. Other query parameter options are provided. Please check Request Body Important Notes section.

trackingId and groupIds are generated by SendTransactionalEmail function call.

Important Notes

  1. When groupId is used, the other query parameters are ignored.
  2. When groupId is not set but there is a transactionId in the request, the other query parameters are ignored.
  3. Either email (maximum 5 email addresses) or tag parameter (maximum 5 tags) can be used at the same time. if the client sends email and tag query parameters in the same query, email query parameter is used and tag is ignored. If the request is made by either tag or email address, beginTime and endTime are required.
  4. If a date range is used by beginDate and endDate parameters, queryTime parameters must be set to either “sent” or “event” times.
  5. Maximum data range (the time gap between beginTime and endTime) is 7 days.

Request Parameters

10 Query Parameters
1 Header

Request Body

Schema
object

Responses

The operation is successfull and returns the transactional email reports with the requested paramaters.

3 Examples
Schema
object
transactionId
string
code
integer
message
string
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
access_token