Skip to main content
GET
Get Connectivity Analytics
Returns the data behind the Connectivity chart in Analytics. Use by_retry_attempt to judge whether more retries are worth it: attempt_2 and later are calls that connected only after a retry.

Notes

  • connectivity_pct runs from 0 to 100, rounded to two decimals, unlike the 0 to 1 rates on other analytics endpoints. It is 0.0 when there are no calls.
  • total includes every call status, including registered, ongoing and retry calls.
  • For calls stopped by the campaign’s end time or retry limit, read volume.connection_rate from Get volume analytics.

Errors

  • 400: a filter is invalid, such as an unknown channel, a malformed ID, or sub_workspace_id sent from a workspace that isn’t a primary workspace.
  • 401: X-API-KEY is missing or invalid.

Authorizations

X-API-KEY
string
header
required

Query Parameters

start_date
string

Start of the reporting window. Accepts YYYY-MM-DD or ISO-8601. Omit both dates for all time.

Example:

"2026-10-01"

end_date
string

End of the reporting window (inclusive). Accepts YYYY-MM-DD or ISO-8601.

Example:

"2026-10-15"

agent_id
string

Filter by one or more agent IDs (comma-separated).

Example:

"00000000-0000-4000-8000-0000000000a1"

agent_version_id
string

Filter by one or more agent version IDs (comma-separated).

Example:

"00000000-0000-4000-8000-0000000000d1"

bulk_list_id
string

Filter by one or more campaign (bulk list) IDs (comma-separated). Callback calls inherit the campaign of their parent call.

Example:

"00000000-0000-4000-8000-0000000000c1"

voicemail
boolean

true returns only voicemail calls, false excludes them. Omit to include all calls.

Example:

false

channel
string

Filter by call channel (comma-separated): inbound, outbound, webcall. Unknown values return 400.

Example:

"outbound"

include_callback
boolean
default:false

Include callback-feature calls (call_category = CALLBACK) in the metrics. Defaults to false.

Example:

false

sub_workspace_id
string<uuid>[]

Primary workspaces only: limit the combined analytics to these Ringg Spaces. Repeat the parameter for multiple IDs. The primary workspace's own ID is accepted; any other workspace sending this parameter gets 400.

Example:

Response

Connectivity analytics retrieved successfully.

connectivity
object