Skip to main content
GET
/
analytics
/
referrals
Error
A valid request URL is required to generate request examples
{
  "data": {},
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (starts with cxp_). Required on every request.

Query Parameters

​
referralStartDate
string<date>

Filter by referral date (start)

​
referralEndDate
string<date>

Filter by referral date (end)

​
firstReferralStartDate
string<date>

Filter by first referral date (start)

​
firstReferralEndDate
string<date>

Filter by first referral date (end)

​
signedStartDate
string<date>

Filter by signed date (start)

​
signedEndDate
string<date>

Filter by signed date (end)

​
tz
string

IANA timezone, defaults to UTC

​
caseType
string

Filter by case type slug

​
jurisdiction
string

Filter by jurisdiction

Response

Referrals analytics data

​
data
object
required

Referrals analytics metrics

​
meta
object
required