---
title: "List ping activity"
method: GET
path: "/v2/sources/pings"
tags: ["Sources"]
---

# List ping activity

`GET /v2/sources/pings`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/sources/pings`
- Auth: API key in header `x-api-key`

See ping-post activity for your sources: totals, a chart over time, and each ping. The chart is hourly for windows up to 3 days and daily after that, and pings come back one page at a time. Covers the last 7 days unless you pick dates. Caller IDs and qualification fields on failed pings are redacted after the retention window.

## Query parameters

- `page` number
- `perPage` number
- `sourceId` string: Source filter: accepts the public source ID or the internal source UUID. Unknown values return an empty result rather than an error.
- `campaignId` string, uuid
- `startDate` string, date-time
- `endDate` string, date-time
- `availability` 'available' | 'unavailable': Filter by the availability answered to the vendor
- `status` 'pending' | 'dialed' | 'expired' | 'unavailable' | 'revoked'

## Response `200`

GET /v2/sources/pings Positive response

- GetV2SourcesPingsPositiveResponse
  - `summary` object, required
    - `total` number, required
    - `available` number, required
    - `unavailable` number, required
    - `dialed` number, required: Pings where the caller actually arrived
    - `billable` number, required: Dialed pings whose matched call produced a billable event
    - `converted` number, required: Dialed pings whose caller later converted (policy created or conversion recorded), cohort-attributed regardless of when the conversion occurred
    - `acceptRate` number, required: available / total, percent
    - `pingToCallRate` number, required: dialed / available, percent
    - `billableRate` number, required: billable / dialed, percent
    - `conversionRate` number, required: converted / dialed, percent
    - `uniqueCallers` number, required
    - `lastPingAt` string, date-time, nullable, required: Most recent ping time. ISO 8601 timestamp
    - `fieldCoverage` object, required
      - `state` number, required
      - `postalCode` number, required
      - `dateOfBirth` number, required
      - `name` number, required
  - `timeseries` object, required
    - `granularity` 'hour' | 'day', required: hour for windows up to 3 days, day beyond
    - `buckets` object[], required
      - `bucketStart` string, date-time, required: UTC bucket start. ISO 8601 timestamp
      - `total` number, required
      - `available` number, required
      - `unavailable` number, required
      - `dialed` number, required
  - `items` object[], required
    - `id` string, uuid, required
    - `createdAt` string, date-time, nullable, required: Ping creation time. ISO 8601 timestamp
    - `sourceId` string, uuid, nullable, required
    - `publicSourceId` string, nullable, required
    - `sourceName` string, nullable, required
    - `campaignSourceId` string, uuid, nullable, required
    - `campaignId` string, uuid, nullable, required
    - `campaignName` string, nullable, required
    - `callerId` string, required
    - `subId` string, nullable, required
    - `agentAvailable` boolean, required
    - `status` 'pending' | 'dialed' | 'expired' | 'unavailable' | 'revoked', required
    - `unavailableReason` string, nullable, required
    - `revocationReason` string, nullable, required
    - `revokedAt` string, date-time, nullable, required: Offer revocation time. ISO 8601 timestamp
    - `returnedNumber` string, nullable, required
    - `consentBasis` string, nullable, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `state` string, nullable, required
    - `postalCode` string, nullable, required
    - `piiPurged` boolean, required
    - `dialedAt` string, date-time, nullable, required: Caller arrival time. ISO 8601 timestamp
    - `billable` boolean, required
    - `converted` boolean, required
    - `callHistoryId` string, uuid, nullable, required
    - `expiresAt` string, date-time, nullable, required: Ping expiration time. ISO 8601 timestamp
  - `itemsTotal` number, required
  - `currentPage` number, required
  - `nextPage` number, nullable, required
  - `prevPage` number, nullable, required

## Other responses

- `400`: GET /v2/sources/pings Negative response 400
- `401`: GET /v2/sources/pings Negative response 401
- `403`: GET /v2/sources/pings Negative response 403
- `404`: GET /v2/sources/pings Negative response 404
- `409`: GET /v2/sources/pings Negative response 409
- `422`: GET /v2/sources/pings Negative response 422
- `429`: GET /v2/sources/pings Negative response 429
- `500`: GET /v2/sources/pings Negative response 500
- `502`: GET /v2/sources/pings Negative response 502
- `503`: GET /v2/sources/pings Negative response 503

---

[API](https://skmtc.dev/carecycle/apis/carecycle-public-api.md) - [All operations](https://skmtc.dev/carecycle/apis/carecycle-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carecycle/apis/carecycle-public-api/revisions/db390c743c36?raw)