Campaign metrics

GET 
/broadcasts/:id/stats

Counters, rates, clicks per button, grouped failures, cost per country, delivery and read latency, and the quality of the number and template before and now. The read, click, reply and opt-out rates are over the delivered ones.

Request

Responses

200

Record found.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

402

No entitlement (payment_required). The body carries the reason in reason and the way out in action: what to do (kind) and the dashboard page where it is done (url).

404

Resource does not exist (not_found).

429

Rate limit exceeded (rate_limit).

Response Headers

Retry-After

Seconds to wait before retrying.

X-RateLimit-Category

Which rate limit category applied — send, media or default.

X-RateLimit-Scope

Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).

X-RateLimit-Limit

Request ceiling for this category in the current window.

X-RateLimit-Remaining

Requests left in the current window.