Help & Documentation
Open Support Ticket

Report Component Data API

This article describes the endpoint for Report Component configuration, supported beginning in v7.2.1:

  • /api/report_component_data: Retrieve Report Components, supports filtering.

PREREQUISITES:

TABLE OF CONTENTS:

  1. Access Admin > System > API Toolkit
  2. Retrieve Report Component Data
  3. Retrieve Report Component Data With Additional Filtering

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.
  1. Item: report_component_data.
  2. Method: GET.
  3. report: Enter the ID of the Report.
  4. dimension_value: Optionally, filter the returned results by the Dimension Value.
  5. component: Optionally, filter the Component by UUID to retrieve its data.
    • If this parameter is not provided, the data of the Component that is shown on tile is returned.
    • Component UUID can be fetched from the dashboard.dataset_renderer_block_component table.
  6. Enter an API Token.
  7. [Run request]

Example Response

{
    "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
    },
    "metadataComponent": {
        "type"                          : "kpi_chart",
        "title"                         : "Sales for All Regions",
        "stoplight_more_is_better"      : "Y",
        "stoplight_color_for_high_values": "#077E45",
        "stoplight_color_for_low_values" : "#AC2B2B"
    },
    "dataResults": {
        "table": [
            { "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 NameValue TypeDescription
metadataobjectTop-level object containing report identification details.
metadata object’s fields:
idintegerThe ID of the Report.
namestringThe name of the Report.
descriptionstringThe description of the Report.
segment_value_idintegerThe ID of the Dimension Value used to filter the report data.
category_idintegerThe ID of the Category the Report belongs to.
business_owner_idintegerThe ID of the Business Owner of the Report.
technical_owner_idintegerThe ID of the Technical Owner of the Report.
metadataComponentobjectConfiguration details of the specific Report Component being returned.
NOTE: Currently, it is only supported for the KPI Chart component.
metadataComponent object’s fields
typestringThe component type. (e.g. "kpi_chart")
titlestringThe display title of the component.
stoplight_more_is_betterstringWhether higher values are considered positive. ("Y"/"N")
stoplight_color_for_high_valuesstringHex color code applied to high/good stoplight values.
stoplight_color_for_low_valuesstringHex color code applied to low/bad stoplight values.
dataResultsobjectContains the query result data for the component.
tablearrayArray of data row objects returned by the component query.

dataResults
objectContains the query result data for the component.
dataResults object’s fields:
table
arrayArray of data row objects returned by the component query.

3. Retrieve Report Component Data With Additional Filtering

  • POST request to /api/report_component_data supports retrieving Report Component data with additional filtering.
  1. Item: report_component_data.
  2. Method: POST.
  3. report: Enter the ID of the Report.
  4. Select JSON request and provide the following parameters:
    • ids: An array of Report IDs.
    • filters: An object of Report's field names and filter values.
  5. Enter an API Token.
  6. [Run request]

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"]
  }
}

Filering 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
    }
  }
}