Admin APIEmail
Get a campaign report
Delivery funnel and rates, opens and clicks over time, top links, bounces, time to first open, and revenue from recipients who engaged (orders within 7 days of their send).
Authorization
bearer_auth AuthorizationBearer <token>
Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
store_id*string
Store id
Format
uuidbroadcast_id*string
Campaign (broadcast) id
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/email/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/report"{
"attribution": {
"buyers": 0,
"orders": 0,
"revenue_cents": 0,
"window_days": 0
},
"bounces": [
{
"count": 0,
"type": "string"
}
],
"funnel": {
"bounced": 0,
"clicked": 0,
"complained": 0,
"delivered": 0,
"failed": 0,
"opened": 0,
"sent": 0,
"total": 0,
"unsubscribed": 0
},
"links": [
{
"clicks": 0,
"unique": 0,
"url": "string"
}
],
"rates": {
"bounce": 0.1,
"click": 0.1,
"complaint": 0.1,
"ctor": 0.1,
"delivery": 0.1,
"open": 0.1,
"unsubscribe": 0.1
},
"time_to_open": [
{
"bucket": "string",
"count": 0
}
],
"timeline": [
{
"clicks": 0,
"hour": "2019-08-24T14:15:22Z",
"opens": 0
}
]
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}