Skip to main content
cURL

Authorizations

Authorization
string
header
required

Issued in Developers. Workspace/owner/scopes come from credential, never acting-user headers. API keys cannot manage API credentials.

Query Parameters

startDate
string<date>
required

First included calendar day in the selected timezone, formatted YYYY-MM-DD. Together with endDate, the range may include at most 366 days.

endDate
string<date>
required

Last included calendar day in the selected timezone. It may equal startDate; the response reports the following midnight as the exclusive UTC end.

timezone
string
default:UTC

IANA timezone used to turn calendar dates into actual instants, including daylight-saving changes. Defaults to UTC. Must be a supported IANA identifier of at most 100 characters.

Maximum string length: 100
listId
integer

Optional visible calling-list ID. Filters by each call’s original session attribution, not the contact’s current list membership. Use a positive integer no greater than 2,147,483,647.

Required range: 1 <= x <= 2147483647
ownerId
string

Optional PowerDialer user ID for a current workspace member permitted by this key. Omit to include all owners allowed by the credential.

groupBy
enum<string>
default:list

Return one row per original calling list (list), per rep (owner), or one combined row (none). Defaults to list. Calls without list attribution can form a null group.

Available options:
list,
owner,
none
conversationThresholdSeconds
integer
default:120

Minimum talk-time threshold used for conversation counts, from 1 to 3600 seconds. Defaults to 120; calls meeting the threshold still follow the documented connection/voicemail rules.

Required range: 1 <= x <= 3600

Response

Scoped metrics grouped as requested, with explicit UTC boundaries and no inferred business conversions.

range
object
required

Resolved UTC interval and requested calendar timezone. The interval ends exclusively after the last requested calendar day.

groupBy
enum<string>
required

How rows are grouped: calling list, member, or one overall row.

Available options:
list,
owner,
none
conversationThresholdSeconds
integer
required

Configured talk-duration threshold used to classify conversations.

data
object[]
required

Metrics for each group visible to the API key. Rates are fractions between 0 and 1.

conversionAvailability
string
required

Explanation of why verified business conversions are not supplied by this API.