CAcarecycle
Calls Metrics

Get calls summary metrics

Aggregate KPIs for the calls dashboard: totals, direction split, avg duration, voicemail/appointment/DNC rates.

get/v2/calls/metrics/summary

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/calls/metrics/summary
  • Auth
    API key in header x-api-key

Query parameters

searchstring

Search query: matches customer name, phone number, or disposition

customerIdstring uuid

Filter calls by customer ID for exact customer call history

campaignIdsstring

Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)

agentUserIdsstring

Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)

durationOperator'<=' | '>='

Duration filter operator (less than or equal, greater than or equal)

durationValuenumber

Duration value in seconds to filter by

direction'inbound' | 'outbound'

Filter by call direction

callType'voice_ai' | 'softphone'

Filter by call type: Voice AI or Softphone

startDatestring date-time

Start date-time for call range filtering. ISO 8601 timestamp

endDatestring date-time

End date-time for call range filtering. ISO 8601 timestamp

excludeDispositionsstring

Array of disposition names to exclude from results (comma-separated string)

includeDispositionsstring

Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.

excludeSourcesstring

Array of source ids to exclude from results (comma-separated string)

includeTestCalls'true' | 'false'

When true, test calls are included in results. Default behavior is to exclude test calls.

connectedCallsOnly'true' | 'false'

Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.

includeErrorDispositions'true' | 'false'

Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.

campaignsstring

GET /v2/calls/metrics/summary Parameter

sourcesstring

GET /v2/calls/metrics/summary Parameter

Response

GET /v2/calls/metrics/summary Positive response

totalnumber required
inboundnumber required
outboundnumber required
avgDurationSecondsnumber required
voicemailRatenumber required
outboundVoicemailCountnumber required
outboundVoicemailRatenumber nullable required
appointmentsBookednumber required
dncDetectedRatenumber required

Changes

No recorded changes to this operation across all 2 revisions of this API.