Skip to main content
GET
Report Fields
The fields a report query can filter, group (view_by / segment_by), measure and show as columns, with each field’s operators and fixed values, plus the period presets and date intervals. Requires a CRM read scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entity
enum<string>
default:activities
Available options:
activities,
deals,
stage_changes,
contacts,
outreach

Response

Successful Response

entity
string
required
label
string
required
noun
string
required

One record, e.g. "deal".

fields
ReportFieldOut · object[]
required
periods
FieldOption · object[]
required
intervals
enum<string>[]
required
Available options:
day,
week,
month,
quarter,
year