Reporting

Dashboard metrics, per-channel reports (email / SMS), recipient lists, click-URL events.

Dashboard metrics, per-channel reports (email / SMS), recipient lists, click-URL events.

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

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`	Campaign dashboard metrics	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 report (single 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	Get a paginated list of email recipients for a campaign, with optional status filter, search, and sort.
`GET`	Email delivered comparison	Get delivered-count comparison between Email and SMS for a campaign, bucketed by day, week, or month.
`GET`	Email click URLs	Get per-URL click statistics for the email channel of a campaign.
`GET`	SMS report	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`	SMS recipients	Get a paginated list of SMS recipients for a campaign, with status filtering, field search, and sorting.
`GET`	SMS click URLs	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 URL events	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.