Skip to main content
GET
/
v2
/
sources
/
performance
Get source performance metrics for a campaign
curl --request GET \
  --url https://api.carecycle.ai/v2/sources/performance \
  --header 'x-api-key: <api-key>'
{
  "sources": [
    {
      "sourceId": "<string>",
      "name": "<string>",
      "leads_dialed": 123,
      "contact_rate": 123,
      "transfer_rate": 123,
      "total_usage_cost": 123,
      "cost_per_transfer": 123,
      "total_calls": 123,
      "billable_calls": 123,
      "billable_percentage": 123,
      "spend": 123,
      "new_transfers": 123,
      "new_calls": 123,
      "new_transfer_percentage": 123,
      "appointment_transfers": 123,
      "appointment_calls": 123,
      "appointment_transfer_percentage": 123,
      "total_transfers": 123,
      "total_transfer_percentage": 123,
      "billable_transfers": 123,
      "billable_transfer_rate": 123,
      "converted_calls": 123,
      "transfer_conversion_rate": 123,
      "cost_per_acquisition": 123
    }
  ],
  "stateBreakdown": [
    {
      "state": "<string>",
      "leads_dialed": 123,
      "contact_rate": 123,
      "transfer_rate": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Query Parameters

campaignId
string<uuid>
required

GET /v2/sources/performance Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
startDate
string<date-time>

GET /v2/sources/performance Parameter

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
endDate
string<date-time>

GET /v2/sources/performance Parameter

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

GET /v2/sources/performance Positive response

sources
object[]
required
stateBreakdown
object[]
required