get

/analytics/job/{id}/email/summary/

View the summary event information for a job over time. Suitable timegrains include FIRST_DAY, FIRST_WEEK, and FIRST_MONTH.

Request Parameters

1 Path Parameter
1 Query Parameter

Responses

OK

1 Example
Schema
object
deliveries
integer

The number of emails delivered within a timegrain.

1 validation
devices
array[object]

High-level device reporting for this job

domains
array[object]

High-level domain reporting for this job

links
array[object]

an array of links to separate pages, following HATEOS syntax

numRecipients
integer

Total recipients intended for this job

1 validation
renderErrors
integer

Number of emails whose templating language content could not be rendered

1 validation
spamRelatedSoftBounces
integer

Number of soft bounces categorized as spam-related

1 validation
suppressedBounces
integer

Number of soft bounces categorized as suppression

1 validation
totalBounces
integer

Total number of bounces for this job

1 validation
totalClicks
integer

Total number of clicks for this job

1 validation
totalHardBounces
integer

Total number of hard bounces for this job

1 validation
totalOpens
integer

The total number of recipients that opened an email

1 validation
totalSoftBounces
integer

Total number of soft bounces for this job

1 validation
totalSpamComplaints
integer

Total number of spam complaints received for this job

1 validation
totalUnsubscribes
integer

Total number of successful unsubscribes for this job

1 validation
uniqueClicks
integer

The number of unique recipients that clicked a link for this job

1 validation
uniqueOpens
integer

The number of unique recipients that opened an email

1 validation
uniqueSpamComplaints
integer

The Unique number of recipients that submitted a spam complaint for this job

1 validation
uniqueUnsubscribes
integer

The unique number of recipients that successfully unsubscribed within this job

1 validation
windowEnd
string

The “window” of time for which there exists the latest data, represented as a string

1 validation
windowStart
string

The “window” of time in which this job started, expressed as a string

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
No $$.env variables are being used in this request.