Skip to main content
Return every value produced by a report’s configured chart. The chart-focused sibling of get_report_data and get_report_pivot_data: use this after get_report when you need the values actually displayed by the chart — categories, series, slices or points — rather than reconstructing them from raw rows or pivot cells. Bar, line and combo charts return categories and series; donut charts return a metric and slices; bubble charts return points. Pivot-backed charts use their relevant aggregates and subtotals, while raw-backed charts apply the chart’s summing and percentage-normalization rules. The complete chart payload is returned in one call, with no pagination. A missing chart configuration, excessive cardinality, or a report too large to calculate raises a clear error. You only see reports you have access to.

Parameters

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.

Response

The response shape depends on the chart’s type. chart_type is the discriminator; data_source reflects the underlying report configuration (raw, chart or pivot_table); autosummed is true when the chart summed values automatically to produce these totals.

Bar, line and combo charts

Body

string
string
Deep link to open this report in the Qobra web app.
string
One of: bar, line, combo.
string
One of: raw, chart, pivot_table.
object[]
The x-axis values, in the order the chart lays them out.
object[]
One entry per plotted series. values is aligned to categories (same length, same order); tooltip_values mirrors it when the chart shows a secondary tooltip metric.
boolean

Donut charts

Body

string
string
Deep link to open this report in the Qobra web app.
string
Always donut.
string
One of: raw, chart, pivot_table.
object
The field the donut is measuring.
object[]
One entry per donut slice.
boolean

Bubble charts

Body

string
string
Deep link to open this report in the Qobra web app.
string
Always scatter.
string
One of: raw, chart, pivot_table.
object[]
One entry per plotted bubble. value sizes the bubble and is null when the chart doesn’t use a size metric.
boolean