This article describes the /api/report_component_data endpoint which allows to retrieve a Report Component's data, with support for filtering. Beginning in v7.2.2, this endpoint also supports retrieving multiple Components in one call, filtering by Component type, limiting results to a given date range, and capping results to the most recent values.
NOTE: For this endpoint's behavior prior to v7.2.2, see Report Component Data API (prior to v7.2.2).
PREREQUISITES:
- Set up API access, verify that you have API access, and obtain a token via the get_token call OR
- Generate Personal API Token.
TABLE OF CONTENTS:
1. Access Admin > System > API Toolkit
2. Retrieve Report Component Data
GET request to /api/report_component_data?report=<Report_ID> returns the selected Report Component's data.
- Item: report_component_data.
- Method: GET.
- report: Enter the ID of the Report.
- Optionally, configure the following parameters:
- dimension_value: Filter the returned results by the Dimension Value.
- component: Enter the Component's UUID to retrieve only that Component's data.
- If omitted, the Component shown on tile is returned.
- Component UUID can be found in the response of a
multi_componentrequest.
- multi_component: Set to
'Y'to return data for all Components on the Report, in the same order shown in the element viewer.'N'by default. - component_type: When
multi_componentis'Y', restrict the returned Components to the specified type(s); e.g.,kpi_chart. - last_values: Enter the number of most-recent data points to return per measure, in chronological order. If omitted, all data points are returned. This has no effect on
pivotComponents. - date_start / date_end: Only return data points on or after
date_startand/or on or beforedate_end(format:YYYY-MM-DD). Providing only one yields an open-ended range in that direction. These two parameters only apply tokpi_chartComponents.
- Enter an API Token.
- [Run request]
Example Response
NOTE: This section demonstrates response for a GET request. A POST response is otherwise identical but nests metadata and components one level deeper, under data["<Report ID>"]; e.g., data["152770"].
{
"status": "OK",
"data": {
"metadata": {
"id": 152770,
"name": "Dataset for Report Component",
"description": "Dataset for Report Component",
"segment_value_id": 12014,
"category_id": 230,
"business_owner_id": 118,
"technical_owner_id": 118
},
"components": [
{
"metadataComponent": {
"type": "kpi_chart",
"title": "Sales By Region",
"show_on_tile": true,
"uid": "block_uid_5",
"stoplight_more_is_better": "Y",
"stoplight_color_for_high_values": "#077E45",
"stoplight_color_for_low_values": "#AC2B2B",
"variance_comparison_basis": null,
"variance_mode": null,
"variance_value": null,
"variance_value_formatted": null,
"variance_baseline_value": null,
"variance_baseline_value_formatted": null,
"variance_target_value": null,
"variance_target_value_formatted": null
},
"measureFields": [
{
"dataset_column_id": 9256,
"dataset_id": 21458,
"aggregation_function": "Sum",
"color": "#2CAFFE",
"label": "total_sales_usd",
"column_name": "Total_Sales_USD",
"display_mask_id": "0",
"display_type": "line",
"reference_name": "total_sales_usd",
"reference_name_escaped": "total_sales_usd",
"uId": "mnncr35k0.bwxrpouxeeh",
"value_type": "numeric",
"y_axis": "left",
"is_primary": "Y",
"overlay_in_tile": "N",
"overlay_in_chart": "N"
}
],
"dataResults": {
"mnncr35k0.bwxrpouxeeh": [
{ "date": "2026-01-26 00:00:00", "value": "76200", "value-formatted": "76,200" },
{ "date": "2026-02-16 00:00:00", "value": "29700", "value-formatted": "29,700" },
{ "date": "2026-02-27 00:00:00", "value": "38400", "value-formatted": "38,400" }
]
}
}
]
}
}
Fields Description
| Parameter Name | Value Type | Description |
|---|---|---|
metadata | object | Top-level object containing report identification details. |
components | array | An array containing one entry by default (the tile Component), or all matching Components when multi_component is 'Y'. |
components[].metadataComponent | object | Configuration details of the Component. Returned for every Component type, not only kpi_chart. |
metadataComponent.type | string | The Component type: line, dataset, pivot, external_visualization, chart, text_block, map_chart, funnel_chart, bubble_chart, range_chart, kpi, kpi_chart, llm. |
metadataComponent.show_on_tile | boolean | Whether this is the Component shown on the element's tile. |
metadataComponent.uid | string | The Component's UUID. Use it as the component parameter to retrieve this Component on its own. |
components[].measureFields | array | For kpi_chart Components, one entry per measure. Each has a uId used as the matching key in dataResults. |
components[].dataResults | object or array |
|
3. Retrieve Report Component Data With Additional Filtering
POST request to /api/report_component_data supports retrieving Report Component data with additional filtering.
- Item: report_component_data.
- Method: POST.
- Select JSON request and provide the following parameters:
- ids: An array of Report IDs, or
"{reportId}_{segmentValueId}"strings.- This parameter is required, unless
allis set to'Y'.
- This parameter is required, unless
- filters: An object of Report's field names and filter values.
- See Filtering Examples for details on available filters.
- report_columns_exist: Set to
'Y'to check that every filter infiltersapplies to this Report. Returnsnullif at least one filter does not apply. - include_report_filters: Set to
'Y'to use only the filters that apply to this Report, and skip the rest.'N'by default, which uses every filter you send, even ones this Report does not normally support.- NOTE:
report_columns_existis checked first. Use whichever fits: an all-or-nothing check, or applying what fits and skipping the rest.
- NOTE:
- all: Set to
'Y'to ignoreidsand instead return every Report you can view that has a Component ofcomponent_type. Ifcomponent_typeis also blank,datasetComponents are used. - last_values: Same as GET, above.
- multi_component: Same as GET, above.
- component_type: Same as GET, above.
- date_start / date_end: Same as GET, above.
- ids: An array of Report IDs, or
- Enter an API Token.
- [Run request]
NOTE: Unlike GET, component is not supported in the POST body. To select a single Component by UUID, use GET with the component query parameter instead.
4. Filtering Examples
Filtering for a single Report:
{
"ids": [152770],
"filters": {
"product_category": ["Books & Media"]
}
}
Filtering across multiple Reports:
{
"ids": [152770, 152771, 152772],
"filters": {
"region": ["Asia Pacific"]
}
}
Filtering for multi-select filter:
{
"ids": [152770],
"filters": {
"product_category": ["Sports & Outdoors","Automotive"]
}
}
Filtering for a range of values:
{
"ids": [152770, 152771],
"filters": {
"product_category": ["Sports & Outdoors", "Automotive"],
"units_sold": {
"from": 0,
"to": 75000
}
}
}
Return all Reports where KPI charts are set to be displayed on tile, limited to the 2 most recent values:
{
"all": "Y",
"component_type": "kpi_chart",
"last_values": 2
}
Return all Components on a Report:
{
"ids": [152770],
"multi_component": "Y"
}
Return only KPI Chart Components:
{
"ids": [152770],
"multi_component": "Y",
"component_type": "kpi_chart"
}
Filtering by date range:
{
"ids": [152770],
"date_start": "2026-01-01",
"date_end": "2026-03-31"
}
Limiting to the 3 most recent values:
{
"ids": [152770],
"last_values": 3
}
Return only Reports whose record satisfies every filter column exactly, others return null:
{
"ids": [152770, 152771],
"filters": {
"product_category": ["Automotive"]
},
"report_columns_exist": "Y"
}
Apply only the filters actually configured on the Report, dropping any that are not configured:
{
"ids": [152770],
"filters": {
"product_category": ["Automotive"],
"some_unconfigured_column": ["X"]
},
"include_report_filters": "Y"
}