Skip to main content
GET
Get campaign analytics

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Campaign ID.

Query Parameters

from
string

Start of the period: an ISO 8601 date or timestamp with a UTC offset, for example 2026-11-01 or 2026-11-01T00:00:00+01:00.

Example:

"2026-11-01"

to
string

End of the period (exclusive): an ISO 8601 date or timestamp with a UTC offset. Must be after from; the period spans at most 366 days.

Example:

"2026-11-10"

phone_number_id
string<uuid>

Only count contacts called from this caller number (a phone number ID). kpis.messages_sent is not filtered: messages have no caller number.

Response

The campaign's analytics.

data
object
required

Per-contact campaign analytics for a period: KPIs, the outcome flow, activity per day and caller numbers. Provider cost is not part of the public payload.