Skip to main content
Return one report’s configuration: the list row plus its columns, filters, sorts, bottom aggregates, chart_options and pivot_table_configuration. Computed values are not here: they come from get_report_data (rows), get_report_pivot_data and get_report_chart_data. In pivot_table_configuration.pivot_table_fields, a pivot field that is also one of the report’s own fields is given by reference: only its id, name, display and origin. Its full definition is the report_fields entry with the same id. A field that exists only in the pivot table, such as an aggregation or a calculated field, keeps its full definition. Needs direct access to the report. For one shown on a dashboard shared with you, call get_report_chart_data or get_report_pivot_data with the report_id of get_dashboard’s visualizations.

Parameters

Body

string
required
Id from list_reports. If refused, find the report there again; do not retry the same id.

Response

Body

string
string
string | null
string
string
object
Source data table tracked by a record report, with its id and name; null for statement reports.
string[]
The dashboard tiles this report can render: chart when a chart is configured on it, pivot_table when a pivot table is. Empty when neither is — the report then has no tile to show on a dashboard.
object
object
object[]
object[]
object[]
object
object
object
string