get_report first to read the
field ids, types and filter and sort configuration that make these rows
interpretable.
You need direct access to the report. For one shown on a dashboard shared with
you, use get_report_pivot_data
or get_report_chart_data.
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). A row amount is unrounded (a bottom aggregate is rounded to 2
decimals), in the column’s currency, the report’s calculation currency. A
percentage is the stored ratio, 0.8 for 80%. A cell whose computation failed is
null and listed in error_cells, never a zero.
A page holds at most min(limit, 200, 1000 / columns returned) rows, so narrow
field_ids to fit more; total_row_count counts every row. A report too large
to compute is refused, and this tool has no filter: read it with
get_report_pivot_data or
get_report_chart_data if it
has a pivot table or chart, or have its filters narrowed in the web app or with
ask_analyst.
A record report has one row per statement, plan and record, for the records
frozen into a statement by a scope on which its plan flags a record metric. A
record frozen by a scope with no flagged metric is in no row, so 0 rows does not
mean that no record reached a statement:
list_statement_records
lists a scope’s frozen records whatever is flagged. A metric is flagged in the
Qobra web app, by the Analyst (ask_analyst) or by the Architect
(ask_architect).
Parameters
Body
Body
string
required
Id from list_reports. If refused, find the report there again; do not retry
the same id.
integer
Rows per page, 1 to 250. Default 50.
integer
Rows to skip. Omit it for the first page, never null or the string ‘None’;
for the next page pass the previous next_offset.
string[]
Columns to return, by the
id of get_report’s report_fields. Omit for
every displayed column. A hidden or unknown id is refused.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