Skip to main content
GET
Download one analytics category as XLSX

Authorizations

X-API-Key
string
header
required

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

Path Parameters

category
enum<string>
required

Analytics category to export

Available options:
dashboard,
cases,
homepage,
received,
sent,
revenue-received,
revenue-sent,
referrals

Query Parameters

referralStartDate
string<date>

Include referrals made on or after this date (YYYY-MM-DD)

referralEndDate
string<date>

Include referrals made on or before this date (YYYY-MM-DD)

firstReferralStartDate
string<date>

Filter by first-referral date (from) (YYYY-MM-DD)

firstReferralEndDate
string<date>

Filter by first-referral date (to) (YYYY-MM-DD)

signedStartDate
string<date>

Filter by signed date (from) (YYYY-MM-DD)

signedEndDate
string<date>

Filter by signed date (to) (YYYY-MM-DD)

tz
string

IANA time zone used for date bucketing, e.g. America/New_York

caseType
string

Restrict to one case type

jurisdiction
string

Restrict to one jurisdiction

firmId
string<uuid>

Accepted for admin-global keys only; ignored for firm-scoped keys, which are always limited to their own firm

Response

XLSX workbook

The response is of type file.