Appointments3

Appointments.Booking Links3

Calendars5

Calls5

Calls Metrics8

Campaign Enrollment4

Campaigns9

Campaigns.Agent Source Restrictions3

Campaigns.Block Snippets3

Campaigns.Templates1

Custom Fields5

Customers9

Customers.Custom Fields3

Customers.Dependents3

Customers.Policies3

Customers.Policies.Custom Fields3

Customers.Prescriptions3

Customers.Providers3

Customers.Relationships5

Customers.Tags2

Dispositions5

Inquiries3

Leads1

Phone Suppressions2

Ping Post1

Routing Groups5

Sandbox5

Sources10

Sync2

Sources

List ping activity

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.

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

Query parameters

pagenumber

GET /v2/sources/pings Parameter

perPagenumber

GET /v2/sources/pings Parameter

sourceIdstring

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

campaignIdstring uuid

GET /v2/sources/pings Parameter

startDatestring date-time

GET /v2/sources/pings Parameter

endDatestring date-time

GET /v2/sources/pings Parameter

availability'available' | 'unavailable'

Filter by the availability answered to the vendor

status'pending' | 'dialed' | 'expired' | 'unavailable' | 'revoked'

GET /v2/sources/pings Parameter

Response

GET /v2/sources/pings Positive response

itemsTotalnumber required

currentPagenumber required

nextPagenumber nullable required

prevPagenumber nullable required

Changes

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