Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Dashboards

Get dashboard chart data

Execute dashboard chart queries and return data. Charts are paginated at 10 per page. Individual chart failures are handled gracefully and return an error message instead of failing the entire request.

get/v2/dashboards/{id}/data

Path parameters

idstring uuid required
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

UUID

Query parameters

pageinteger

Select the page of the result

date_startstring
Example:2026-01-01

Start date filter (inclusive)

date_endstring
Example:2026-12-31

End date filter (inclusive)

user_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by user ID

origin_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by origin ID

origin_group_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by origin group ID

tag_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by tag ID

timezonestring
Example:America/Sao_Paulo

Timezone for date calculations

limitinteger

Limit rows returned per chart (applies to table/list chart types)

chart_idsstring
Example:uuid-1,uuid-2

Comma-separated list of chart IDs to fetch (returns only these charts instead of all)

Headers

api-tokenstring required

API Token

Response

Chart data for the dashboard

statusinteger

Response status

total_countinteger

Total items based on current filters

pageinteger

Current page

total_pagesinteger

Total pages based on current filters

has_nextboolean

Indicates that has next page

has_previousboolean

Indicates that has previous page

Example response

{
  "status": 200,
  "total_count": 50,
  "page": 1,
  "total_pages": 10,
  "has_next": true,
  "data": {
    "charts": [
      {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "name": "Monthly Revenue",
        "type": "number",
        "result": {
          "value": 42
        },
        "error": "Failed to fetch chart data"
      }
    ]
  }
}