v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Analytics

Get campaign metrics

Returns aggregated engagement metrics plus a lifetime per-link click breakdown and lifetime Poll/NPS summaries for a specific campaign. Clicked links and poll summaries are not limited by period/start/end.

get/metrics/campaigns/{campaignId}

Path parameters

campaignIdstring required

Campaign ID

Query parameters

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding time window. Ignored when start and end are provided.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

mailboxProviderstring

Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies, conversions, and revenue as 0 because those metrics cannot be segmented per provider.

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events.

Response

Success

successboolean
campaignIdstring
periodstring

Echoed back when period is provided.

mailboxProviderstring

Echoed back when mailboxProvider is provided.