Sources

List ping activity

Ping-post activity for the client's sources: summary counters, a chartable time series (hourly up to 3-day windows, daily beyond), and a paginated list of individual ping sessions. Defaults to the trailing 7 days when no date window is provided. Caller IDs and qualification fields on failed pings are redacted after the retention window.

Authorization

x-api-key

x-api-key<token>

API key required for authentication.

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

In: header

Query Parameters

number

GET /v2/sources/pings Parameter

Default1Range1 <= value

number

GET /v2/sources/pings Parameter

Default50Range1 <= value <= 100

string

Source filter: accepts the public source ID or the internal source UUID. Unknown values return an empty result rather than an error.

Lengthlength <= 255

string

GET /v2/sources/pings Parameter

Match^([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)$Formatuuid

string

GET /v2/sources/pings Parameter

Match^(?:(?:\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))$Formatdate-time

string

GET /v2/sources/pings Parameter

Match^(?:(?:\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))$Formatdate-time

string

Filter by the availability answered to the vendor

Value in"available" | "unavailable"

string

GET /v2/sources/pings Parameter

Value in"pending" | "dialed" | "expired" | "unavailable"

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X GET "https://api.carecycle.ai/v2/sources/pings"

{
  "summary": {
    "total": 0,
    "available": 0,
    "unavailable": 0,
    "dialed": 0,
    "billable": 0,
    "converted": 0,
    "acceptRate": 0,
    "pingToCallRate": 0,
    "billableRate": 0,
    "conversionRate": 0,
    "uniqueCallers": 0,
    "lastPingAt": null,
    "fieldCoverage": {
      "state": 0,
      "postalCode": 0,
      "dateOfBirth": 0,
      "name": 0
    }
  },
  "timeseries": {
    "granularity": "hour",
    "buckets": [
      {
        "bucketStart": "string",
        "total": 0,
        "available": 0,
        "unavailable": 0,
        "dialed": 0
      }
    ]
  },
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdAt": null,
      "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
      "publicSourceId": "string",
      "sourceName": "string",
      "campaignSourceId": "6c01d52e-d0de-4719-a11a-73358f8962c1",
      "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
      "campaignName": "string",
      "callerId": "string",
      "subId": "string",
      "agentAvailable": true,
      "status": "pending",
      "unavailableReason": "string",
      "returnedNumber": "string",
      "consentBasis": "string",
      "firstName": "string",
      "lastName": "string",
      "state": "string",
      "postalCode": "string",
      "piiPurged": true,
      "dialedAt": null,
      "billable": true,
      "converted": true,
      "callHistoryId": "46a83297-ff2f-4459-b814-121492cc2e8a",
      "expiresAt": null
    }
  ],
  "itemsTotal": 0,
  "currentPage": 0,
  "nextPage": 0,
  "prevPage": 0
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "path": [
        "string"
      ],
      "message": "string",
      "expected": "string",
      "received": "string",
      "code": "string"
    }
  ],
  "failedRecords": [
    {
      "index": 0,
      "phoneNumber": "string",
      "firstName": "string",
      "lastName": "string",
      "externalId": "string"
    }
  ]
}

{
  "message": "string",
  "code": "string",
  "retryAfter": 0
}

{
  "message": "string",
  "code": "string"
}

List campaign assignments for a source GET

Previous Page

Update a source campaign assignment PATCH

Next Page