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

Start of the reporting window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and read as that day at 00:00:00Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window.

dateToUTC
string

End of the reporting window, inclusive. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window.

projectName
string

Optional display label alongside locationId. It never identifies a tenant; selecting by name alone returns 400.

Minimum string length: 1
locationId
string

Location ID of the project to read. Required when selecting a project; omit every project selector for an agency-wide read. Project names are labels only and never select a project on their own.

Minimum string length: 1
locationIds
string[]

Canonical Location IDs for selecting multiple projects. Names are labels only and cannot identify the selection.

Minimum string length: 1
agency
string

Restrict the comparison to a single agency tag.

Minimum string length: 1
projects
string[]

Optional display labels accompanying locationIds. Names alone cannot select projects.

Minimum string length: 1
excludeProjects
string[]

Optional display labels accompanying excludeLocationIds. Names alone cannot exclude projects.

Minimum string length: 1
excludeLocationIds
string[]

Canonical Location IDs to exclude.

Minimum string length: 1
campaignId
string

Restrict the comparison to the leads one campaign dialled. Calls recorded without campaign attribution are not returned by this filter, so an older window can show fewer leads here than an unfiltered read.

Minimum string length: 1
masterCampaignId
string

Restrict the comparison 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
agentVariantId
string

Restrict the figures to one Agent Variant inside a split test, so two variants of the same campaign can be compared. Requires campaignId and cannot be combined with masterCampaignId: a variant id only identifies a variant within its own campaign, so an unscoped one has no meaning and is rejected.

Minimum string length: 1

Response

Booking rate per project.

success
boolean
required
Example:

true

data
object[]
required

One row per project, sorted by booking rate descending. Projects with no leads in the window are omitted.