Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Emails

Get Status

Get status details of an email transaction. Required Access Level: ViewReports

get/emails/{transactionid}/status

Path parameters

transactionidstring string required

string

Transaction identifier

Query parameters

showFailedboolean

boolean

Include Bounced email addresses.

showSentboolean

boolean

Include Sent email addresses.

showDeliveredboolean

boolean

Include all delivered email addresses.

showPendingboolean

boolean

Include Ready to send email addresses.

showOpenedboolean

boolean

Include Opened email addresses.

showClickedboolean

boolean

Include Clicked email addresses.

showAbuseboolean

boolean

Include Reported as abuse email addresses.

showUnsubscribedboolean

boolean

Include Unsubscribed email addresses.

showErrorsboolean

boolean

Include error messages for bounced emails.

showMessageIDsboolean

boolean

Include all MessageIDs for this transaction

Response

OK

IDstring string

ID number of your attachment

Statusstring string

Name of status: submitted, complete, in_progress

RecipientsCountinteger
FailedCountinteger

Total emails failed.

Sentstring[]
SentCountinteger

Total emails sent.

Deliveredstring[]

Number of delivered messages

DeliveredCountinteger
Pendingstring[]
PendingCountinteger
Openedstring[]

Number of opened messages

OpenedCountinteger

Total emails opened.

Clickedstring[]

Number of clicked messages

ClickedCountinteger

Total emails clicked

Unsubscribedstring[]

Number of unsubscribed messages

UnsubscribedCountinteger

Total emails unsubscribed

AbuseReportsstring[]
AbuseReportsCountinteger
MessageIDsstring[]

List of all MessageIDs for this job.

Example response

{
  "ID": "123456",
  "Delivered": [
    "1000"
  ],
  "Opened": [
    "1000"
  ],
  "Clicked": [
    "1000"
  ],
  "Unsubscribed": [
    "1000"
  ]
}