Skip to main content
GET
Get received-referral analytics

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Response

Received-referral analytics

data
object
required

Received-referral analytics object. Documented here (partially): warmTransfer; other sections (kpis, currentStageBreakdown, currentStageStats, activePipeline, activePipelineFlow, timeToAcknowledgeTrend, timeToAcknowledgeStats, timeToSignTrend, timeToSignStats, outcomesOfReceived, outcomesReceivedStats, outcomesOfClosed, outcomesClosedStats, topSendingFirms, topCaseTypeJurisdictions) are returned as-is. timeToAcknowledgeStats carries case-level mean/median/p90 (acknowledgements above outlierThresholdHours are excluded from every average and counted separately), a dense day/week/month-bucketed trend over [rangeStart, rangeEnd] where avgHours is null for buckets with no acknowledgements, and a previous-window comparison when a referral date range is active. timeToSignStats carries the same shape for sent-to-signed durations in days (threshold 365), bucketed on the signed date. activePipelineFlow carries the five active stages in flow order with, per stage, the current count, its share of the active total, the number of referrals that ever reached it, and the percentage of those that ever reached the next stage (measured on status history, so it never exceeds 100%), plus trailing-30-day throughput figures each with the preceding window beside it. currentStageStats carries every stage with a case in it now or 30 days ago, busiest first, each with its current count, its occupancy 30 days ago (replayed from status history, not from a stored snapshot) and its share of the total. outcomesReceivedStats and outcomesClosedStats each carry the outcome mix in a fixed order (so a slice keeps its colour as counts move), every row with a display label, its count and its share, plus the total and the immediately preceding window's total.

meta
object
required