GetTransactionalEmailReport

get

https://api.dengage.com/rest/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 Note
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. Maximum data range (the time gap between beginTime and endTime) is 7 days.

Query Params

groupId

string

length between 36 and 36

uuid of the group.

trackingId

string

length between 36 and 36

uuid of the transaction

tag

string

tag provided while sending the transactional email

beginTime

string

required

beginTime is the start time of the query. This field is used only if there is no groupId or transactionId in the request.

The format is yyyy-MM-dd HH:mm:ss

endTime

string

required

endTime is the start time of the query. This field is used only if there is no groupId or transactionId in the request.

The format is yyyy-MM-dd HH:mm:ss

string

email address to get report

limit

integer

100 to 1000

offset

integer

≥ 0

eventType

string

event type to get report

Body Params

Headers

Authorization

string

required

Defaults to {$$.env.access_token}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Not auhenticated. Please re-login.

429

Too Many Requests

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Bounced

Clicked

Delivered and Openned

TooManyRequest

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

400Bad request. Some request parameters are missing or invalid.

403The operation is not allowed. Your api user is not authorized to use this api.