Campaigns
Get Campaign Metrics
Returns aggregate campaign performance — leads, emails sent, opens, replies, bounces and their rates — plus a send trend bucketed over time. Use days (or from/to) and granularity to shape the trend window.
get/api/v1/campaigns/{campaign_id}/metrics
Request
- Base URLhttp://localhost:3009
- AuthHTTP bearer
Path parameters
campaign_idstring required
Campaign ID
Query parameters
granularity'hour' | 'day'
Trend bucket size. Defaults to day.
tzstring
IANA timezone for bucketing (e.g. America/New_York)
daysstring
Trailing window in days
fromstring
Window start (ISO 8601)
tostring
Window end (ISO 8601)
Response
Default Response
Changes
No recorded changes to this operation across all 1 revision of this API.