Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

dateFromUTC
string<date-time>

Start of the reporting window as a UTC ISO timestamp.

dateToUTC
string<date-time>

End of the reporting window as a UTC ISO timestamp.

projectName
string

Optional project filter. Restricted to projects the caller can access.

Minimum string length: 1
campaignId
string

Restrict the summary to the leads one campaign dialled. Only V2 activity carries campaign attribution.

Minimum string length: 1
masterCampaignId
string

Restrict the summary to the leads an entire master campaign dialled, across every linked project the caller can see. A master campaign is fanned out into one child campaign per project, each with its own id, so filtering by a single campaignId returns one project's share of it. Mutually exclusive with campaignId: the two are contradictory scopes rather than narrowing ones, and sending both is a 400.

Minimum string length: 1

Response

Analytics summary metrics.

success
boolean
required
Example:

true

data
object
required

Minimal, non-billing performance summary. Counts plus derived rate percentages.