List a campaign report

Lists one of the campaign's reports, chosen by type, in the order its rows were recorded:

  • recipients: the contacts the campaign was sent to (RecipientResource)
  • opens: the recipients who opened it, with device, mail client and location (OpenResource)
  • clicks: the links the recipients clicked, one per recipient and link (ClickResource)
  • bounces: the recipients whose email bounced, with the reason (BounceResource)
  • unsubscribes: the recipients who unsubscribed (UnsubscribeResource)
  • spam_complaints: the recipients who reported it as spam (SpamComplaintResource)

The lists keep growing while recipients engage with the campaign. Keep the same type and filters while
following next_page_token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The campaign.

Query Params
string
enum
required

What to list.

Allowed:
int32
1 to 100
string
int32
string

Only the rows of this email address (letter case aside).

string

Only opens by addresses of this email domain, e.g. gmail.com (type=opens only).

string
enum

Only hard or only soft bounces (type=bounces only).

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json