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.
Date values in rows are pre-formatted strings, not raw ISO dates. Each
date column is rendered exactly the way the report displays it on screen, on
the company’s fiscal calendar, and in the caller’s language: the statement
period column shows a month (Dec 2026 in English, Déc. 2026 in
French), and every other date column shows a day (Dec 23, 2026 /
23 déc. 2026). Do not try to parse these values as dates — treat them as
display labels. bottom_aggregates still return raw values, so a
min/max over a date column is a parseable ISO date.
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
Id of the report to read — the id list_reports returns.
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. Any offset >= 0 is accepted; it does not have to be a multiple of
limit, so you can start from an arbitrary row. Pass the next_offset returned
by the previous call to walk the pages, 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.