Get transfer rate by project
Returns the live-transfer rate for each project as transfers divided by leads, sorted highest first. Projects with no leads in the window are omitted rather than reported as a zero rate.
Rows cover every project this key can see. An agency key gets that agency’s projects.
Allowed customer roles: agency_admin, project_user.
Required API key scope: dashboard:read.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Query Parameters
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.
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.
Optional display label alongside locationId. It never identifies a tenant; selecting by name alone returns 400.
1Location 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.
1Canonical Location IDs for selecting multiple projects. Names are labels only and cannot identify the selection.
1Restrict the comparison to a single agency tag.
1Optional display labels accompanying locationIds. Names alone cannot select projects.
1Optional display labels accompanying excludeLocationIds. Names alone cannot exclude projects.
1Canonical Location IDs to exclude.
1Restrict 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.
1Restrict 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.
1Restrict 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.
1