Practical guides
Check campaign results
Find a campaign and read its aggregate metrics without changing it.
Access: workspaces:read and campaigns:read. Effect: views information only.
- Find your workspace ID.
- List campaigns and copy the intended campaign's
id. - Get campaign metrics using that workspace and campaign ID.
- Use the reference's response field definitions when displaying results. Keep counts and rates labelled with their actual meaning.
Success: an HTTP 200 response containing the requested campaign's metrics. Zero counts are valid; they do not mean the connection failed. Aggregate metrics do not include message bodies or email sequences.
To inspect individual recipients, use List campaign leads with campaignLeads:read. Follow links.next until it is absent or null to retrieve the complete list; keep the same filters between pages.