/v1/reports/catalogueWhat a report can be built from
The vocabulary behind the Reports page: every source a report can count (deals, leads, submissions, offers, tasks) with its fields and what each field is (dimension, measure, date or computed KPI) and its unit, the aggregates (count, sum, avg, min, max), the operators, the periods a date can be grouped by, and max_rows. Read this before writing a definition for post_reports_preview or post_reports_views — a field that is not here cannot be asked for, and a figure this schema cannot answer is absent rather than zero.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"aggregates": [
{
"key": "string",
"label": "string"
}
],
"max_rows": 1.5,
"operators": [
{
"key": "string",
"label": "string"
}
],
"periods": [
{
"key": "string",
"label": "string"
}
],
"sources": [
{
"fields": [
{
"help": "string",
"identifying": true,
"key": "string",
"kind": "string",
"label": "string",
"unit": "string"
}
],
"key": "string",
"label": "string"
}
]
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}