Get a campaign report
GET /stats/campaigns/{id}/report
GET
/stats/campaigns/{id}/report
Deliverability, human and machine opens and clicks with exact uniques, per-link clicks, hour of day by weekday matrices in the campaign timezone, device, client and OS breakdowns, the conversion and revenue metrics, every conversion event type and a timeline. Computed at read time. Opens and clicks of opted-out subscribers are left out of the human and machine counts unless include_opted_out is true. Gmail Postmaster figures are not included.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Query Parameters
Section titled “Query Parameters ” include_opted_out
string
Responses
Section titled “ Responses ”object
breakdowns
required
object
clients
required
Array<object>
object
clicks
required
integer
opens
required
integer
value
required
string
devices
required
Array<object>
object
clicks
required
integer
opens
required
integer
value
required
string
operating_systems
required
Array<object>
object
clicks
required
integer
opens
required
integer
value
required
string
campaign_id
required
string
clicks
required
object
human
required
object
total
required
integer
unique
required
integer
human_unique_rate
required
number
machine
required
object
by_reason
required
Array<object>
object
reason
required
string
total
required
integer
unique
required
integer
total
required
integer
unique
required
integer
opted_out
required
object
total
required
integer
unique
required
integer
total
required
integer
unique
required
integer
deliverability
required
object
complaints
required
integer
delivered
required
integer
hard_bounces
required
integer
sent
required
integer
soft_bounces
required
integer
unsubscribes
required
integer
events
required
object
items
required
Array<object>
object
attributed
required
object
converters
required
integer
count
required
integer
sums
required
Array<object>
object
currency
required
string
sum_cents
required
integer
event
required
string
unattributed
required
integer
unattributed_from
required
string format: date-time
unattributed_to
required
string format: date-time
first_sent_at
required
string format: date-time
generated_at
required
string format: date-time
hour_weekday
required
object
clicks
required
Array<Array<integer>>
opens
required
Array<Array<integer>>
timezone
required
string
weekdays
required
Array<string>
include_opted_out
required
boolean
links
required
Array<object>
object
human_clicks
required
integer
human_unique_clicks
required
integer
link
required
string
total_clicks
required
integer
links_omitted
required
integer
metrics
required
object
conversion
required
object
converters
required
integer
count
required
integer
event
required
string
rate
required
number
source
required
string
revenue
required
object
count
required
integer
currency
required
string
event
required
string
source
required
string
sum_cents
required
integer
sums_by_currency
required
Array<object>
object
currency
required
string
sum_cents
required
integer
name
required
string
notes
required
Array<string>
opens
required
object
human
required
object
total
required
integer
unique
required
integer
human_unique_rate
required
number
machine
required
object
by_reason
required
Array<object>
object
reason
required
string
total
required
integer
unique
required
integer
total
required
integer
unique
required
integer
opted_out
required
object
total
required
integer
unique
required
integer
total
required
integer
unique
required
integer
status
required
string
timeline
required
object
buckets
required
Array<object>
object
at
required
string format: date-time
complaints
required
integer
delivered
required
integer
hard_bounces
required
integer
human_clicks
required
integer
human_opens
required
integer
machine_clicks
required
integer
machine_opens
required
integer
sent
required
integer
soft_bounces
required
integer
unsubscribes
required
integer
granularity
required
string
Invalid_request
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string
Invalid_credential
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string
Insufficient_scope
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string
Not_found
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string
Rate_limited
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string
Internal_error
object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string