Skip to main content
GET
Get campaign submission statistics

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

observed_recipient_count
integer
required

Unique recipients with a recorded provider submission outcome; this is not the campaign audience.

Required range: 0 <= x <= 9007199254740991
accepted_submission_count
integer
required

Latest recorded submissions accepted by the email provider.

Required range: 0 <= x <= 9007199254740991
failed_submission_count
integer
required

Latest recorded submissions that failed before acceptance.

Required range: 0 <= x <= 9007199254740991
inbox_delivery_count
null
required

Unavailable: campaign inbox-delivery tracking is not enabled.

open_count
null
required

Unavailable: campaign open tracking is not enabled.

click_count
null
required

Unavailable: campaign click tracking is not enabled.

tracking_status
enum<string>
required

Inbox-delivery, open, and click tracking are unavailable.

Available options:
unavailable
tracking_unavailable_reason
enum<string>
required

Campaign inbox-delivery, open, and click tracking is unavailable.

Available options:
tracking_not_implemented