Skip to content

Get Campaign Metrics

GET
/campaigns/{campaign_id}/metrics

Get campaign execution metrics — sequence status + email sent/replied counts.

Thin wrapper around the existing campaigns.metrics handler. The handler queries ClickHouse for per-sequence event aggregates and joins them to the campaign’s linked sequences via cb_campaign_sequence_links.

Read-only. Returns the same shape the handler produces. Each campaign carries a metric_status (available | zero | stale | unknown | missing) that reconciles the ClickHouse engagement rollup against Postgres send receipts (seqcontactexecutedsteps): if analytics are unreachable the status is unknown (NOT a zero), and if send receipts prove sends the rollup has not counted the status is stale. Read reconciliation and measured_range before concluding anything about delivery — never treat a bare zero as an outage.

Authorizations

Parameters

Path Parameters

campaign_id
required

Campaign ID

string

Campaign ID

Query Parameters

days

Lookback window in days

integer
default: 30 >= 1 <= 365

Lookback window in days

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string