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.
Prerequisites
- A bearer token in the
Authorizationheader. 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
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | Request totals | Get aggregated email/SMS campaign performance stats and audience contact counts for the authenticated user's company over a given date range, optionally scoped to one store. |
GET | Email results for a campaign | Get email-channel KPIs (recipients, sent, delivered, opened, clicked, unsubscribed, failed, processed, tests/kiosk counts plus derived rates) and a fixed last-7-day daily timeseries for a single campaign. |
GET | Email recipients and status | Get a paginated list of email recipients for a campaign, with optional status filter, search, and sort. |
GET | Email delivery comparison | Get delivered-count comparison between Email and SMS for a campaign, bucketed by day, week, or month. |
GET | Email links clicked | Get per-URL click statistics for the email channel of a campaign. |
GET | Text results for a campaign | Get SMS-channel KPIs (valid recipients, processed, sent, delivered, clicked, failed, tests, kiosk) plus computed rates and a per-day timeseries for one campaign. |
GET | Text recipients and status | Get a paginated list of SMS recipients for a campaign, with status filtering, field search, and sorting. |
GET | Text links clicked | Get SMS click-URL statistics for a campaign — one row per campaign_click_urls (channel sms) with click count, distinct-IP count, and last-clicked timestamp over the date window. |
GET | Click events for a link | Get paginated individual click events for one tracked click URL (across both email and SMS requests), with per-event metadata and the associated customer/recipient data. |