Skip to main content
GET
Get Campaign Metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scope
enum<string>
default:user

Reporting scope. Defaults to user (requires a personal User API key). Set to org to aggregate across all team members in the organization (requires an Organization API key).

Available options:
user,
org
status
string
default:all

Filter campaigns by status (all, running, paused, queued, completed, stopped, archived). Supports comma-separated values (e.g. running,completed).

startDate
string

Filter campaigns created on or after this date (ISO 8601 timestamp or YYYY-MM-DD).

Example:

"2026-10-01"

endDate
string

Filter campaigns created on or before this date (ISO 8601 timestamp or YYYY-MM-DD).

Example:

"2026-11-09"

limit
integer
default:25

Number of campaign items to return per page in the campaigns array (1 to 100, sorted newest-first). Does not limit summary or byUser totals.

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset for the campaigns array (0 or greater).

Required range: x >= 0

Response

Campaign list, aggregate summary metrics, and conversion rates.

scope
enum<string>

The resolved reporting scope.

Available options:
user,
organization
timeframe
object
summary
object
byUser
object[]

Per-seat campaign performance breakdown (only included when scope=org).

campaigns
object[]
pagination
object