Skip to main content
Return one report’s full detail: the list summary plus its configuration. The natural follow-up to list_reports: take a report and read how it is built — its columns and their types, the filters and sort applied, the bottom-of-column aggregates, and the pivot-table / chart layout when configured. This is the configuration that makes the report’s data interpretable; the computed rows and pivot cells live behind get_report_data and get_report_pivot_data. access (who can view the report) is only returned to callers with write access on reports; read-only callers get access: null.

Parameters

Body

report
string
required
The report to read. Accepts the report’s ObjectId (the id returned by list_reports) or a case- and accent-insensitive substring of its name. A name matching no — or more than one — report raises a clear error; pass the full id to disambiguate.

Response

Body

report_id
string
report_name
string
description
string
report_type
string
calculation_currency
string
section
object
access
object
report_fields
object[]
bottom_aggregates
object[]
report_sorts
object[]
filters
object
chart_options
object
pivot_table_configuration
object
resource_url
string
reporting_table
string