Docs Home All APIs

Analytics API

Campaign performance metrics for public API integrations

Campaign Performance Analytics

The Analytics API exposes campaign performance statistics using the same organization API key authentication as the Campaigns API. OpenAPI version 1.1.0 adds date-scoped campaign trends, sequence-email performance, organization rollups, lead-level outcomes, and lead activity while keeping the lifetime campaign summary endpoint intact.

Lifetime campaign totals

Use GET /api/v1/campaigns/{campaign_id}/analytics for the existing no-date-filter campaign summary.

Date-scoped campaign trends

Query /analytics/timeseries?filter[start_date]=2026-05-01&filter[end_date]=2026-05-31&granularity=week.

Organization scoped

Read account-level totals with GET /api/v1/analytics/overview?filter[start_date]=2026-05-01&filter[end_date]=2026-05-31.

Sequence and lead detail

Use /analytics/sequence?filter[start_date]=2026-05-01&filter[end_date]=2026-05-31&granularity=week and lifetime /analytics/leads.

Date-Scoped Example Request

GET
/api/v1/campaigns/{campaign_id}/analytics/timeseries?filter[start_date]=2026-05-01&filter[end_date]=2026-05-31&granularity=week
curl -X GET "https://beam.lightmeter.io/api/v1/campaigns/4ed5a7d2-320c-445e-a16c-7ab932bc259a/analytics/timeseries?filter[start_date]=2026-05-01&filter[end_date]=2026-05-31&granularity=week" \ -H "Authorization: Bearer your_api_key_here" \ -H "Content-Type: application/json"

Reply Metric Semantics

The API exposes human reply metrics and end-autoreply metrics separately.

  • reply_rate remains human-only.
  • end_autoreply_rate covers automated non-bounce replies such as out-of-office messages.
  • Sender-level precedence applies: if a sender has any human reply in the campaign, they count only toward reply_rate and not end_autoreply_rate.
  • Both rates use the same deliverable-leads proxy denominator: leads_contacted - all_bounces.