get_report’s
pivot_configuration): returns the row groups, the column groups, the
measures, and the flattened cells (one per row-path × column-path × measure),
respecting the caller’s visibility. __total__ in a path marks a subtotal or
grand-total. For a flat (non-pivot) report, use get_report_data instead —
calling this on a report with no pivot configuration raises a clear error.
Grouped date values in row_path and column_path are pre-formatted
period labels, not raw ISO dates. Each grouped date field is labelled by the
period it covers on the company’s fiscal calendar, at the group’s own
granularity — Dec 2026 for a monthly group, Q1 2026 for a quarter,
H1 2026 for a semester, 2026 for a year — in the caller’s language
(Janv. 2020 / T1 2026 / S1 2026 in French). A pivot cannot group
dates by day. Measure values in cells are unaffected: a date-typed
measure keeps its raw ISO value.
Paginated like every list tool: limit caps the number of cells per call,
offset walks the pages (next_offset is null on the last one),
total_cell_count is the full size. A page holds whole pivot rows, so it may
return slightly fewer cells than limit (never more), and always at least one
row. A pivot too large to compute on the fly raises an actionable error. 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.
Response
Body
Body
string
string
Deep link to open this report in the Qobra web app.
object[]
The fields laid out on rows, outermost first.
object[]
The fields laid out on columns, outermost first.
object[]
object[]
One cell per row-path × column-path × measure;
__total__ in a path marks
a subtotal/grand-total position.integer
integer
integer
Row offset for the next page — pass it back as
offset to fetch the
following cells. null on the last page.