Account reports: campaign reporting

How your review requests performed: sent, delivered, opened, clicked, and which links people clicked.

How your review requests performed: sent, delivered, opened, clicked, and which links people clicked, by campaign and by channel.

You'll need an account token and a campaign_id for the per-campaign reports.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Request totals

GET — Get totals across all campaigns: sent, delivered, opened, clicked, reviews produced.

Open →

Email results for a campaign

GET — Get one campaign's email numbers: sent, delivered, opened, clicked, bounced, unsubscribed.

Open →

Email delivery comparison

GET — Compare delivered versus sent over time for a campaign.

Open →

Email recipients and status

GET — Get each email recipient with their status.

Open →

Email links clicked

GET — Get which links in the email were clicked and how often.

Open →

Text results for a campaign

GET — Get one campaign's text numbers: sent, delivered, clicked.

Open →

Text recipients and status

GET — Get each text recipient with their status.

Open →

Text links clicked

GET — Get which links in texts were clicked.

Open →

Click events for a link

GET — Get the individual click events on a tracked link: when, from where.

Open →


Did this page help you?