get_report: once you know how a report is built, read its
data. Returns the displayed columns, the row values (aligned to the columns),
and the bottom-of-column aggregates, respecting the report’s filters, sort and
the caller’s visibility. Use get_report first to read the field ids, types
and filter/sort configuration that make these rows interpretable; use
get_report_pivot_data for a report shown as a pivot table.
Paginated like every list tool: limit rows per call, offset to walk the
pages (next_offset is null on the last one), total_row_count for the
full size. Only the report’s displayed columns are ever returned. A report too
large to compute on the fly raises a clear error asking you to narrow it with
filters. You only see reports you have access to.
Parameters
Body
Body
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.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this
page. Pass the next_offset returned by the previous call, or None for the
first page.
string[]
Restrict the returned columns to these field ids (as returned by
get_report). Omit to return all of the report’s displayed columns. Hidden or
unknown field ids are rejected.