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

report
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

report_id
string
resource_url
string
Deep link to open this report in the Qobra web app.
chart_type
string
One of: bar, line, combo.
data_source
string
One of: raw, chart, pivot_table.
categories
object[]
The x-axis values, in the order the chart lays them out.
series
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.
autosummed
boolean

Donut charts

Body

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

Bubble charts

Body

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