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. Values are machine values: a date is YYYY-MM-DD and
its column’s date_granularity says whether it stands for a day or a whole
month (the statement period); an amount is unrounded, in its column’s
currency. A cell whose computation failed is null and listed in
error_cells, never a zero.
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, or get_report_chart_data for the values
displayed by its configured chart.
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.
Response
Body
Body
object[]
any[][]
One entry per row, aligned to
columns. Values are machine values: a date
is a YYYY-MM-DD string (see the column’s date_granularity), an amount is
unrounded in the column’s currency, and a user is {id, email, name}. A
cell listed in error_cells is null.object[]
The cells whose computation failed. Each such cell is
null in rows;
never read it as a zero.object[]
integer
integer
string
string
integer