v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Statistics

Get call status distribution

Returns the distribution of calls by status, plus count of contacts not yet called. Pass workspaceId to narrow to a single workspace within the API key scope. The legacy teamId parameter is still accepted but adds a Deprecation: true response header.

get/v1/stats/status-repartition

Query parameters

sequenceIdstring

Filter by sequence ID

userMembershipIdstring

Filter by user membership ID

callType'all' | 'sequence' | 'direct' | 'inbound' | 'outbound'

Filter by call type. "all" includes sequence + direct calls.

granularity'hour' | 'day' | 'week' | 'month' | 'none'

Time granularity for grouping results

startDatestring

Start date (ISO format)

endDatestring

End date (ISO format)

workspaceIdstring

Filter stats by a single workspace ID (must be within the API key scope). Stats endpoints accept exactly one workspace, unlike list endpoints which support a comma-separated workspaceIds filter. Replaces the deprecated teamId.

teamIdstring

Deprecated — use workspaceId instead. When set, the response includes a Deprecation: true header.

Response

Status distribution statistics

nonCalledCountnumber required

Number of contacts that have not been called yet

Example response

{
  "data": [
    {
      "date": "2023-10-01T00:00:00.000Z"
    }
  ]
}