v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Dashboards

Retrieve a dashboard

Retrieve a single dashboard with its list of charts.

get/v2/dashboards/{id}

Path parameters

idstring uuid required

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

UUID

Headers

api-tokenstring required

API Token

Response

Dashboard details with charts

statusinteger

Example response

{
  "status": 200,
  "data": {
    "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "name": "Sales Dashboard",
    "created_at": "2020-01-01T14:15:00.000000+00:00",
    "updated_at": "2020-01-01T14:15:00.000000+00:00",
    "charts": [
      {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "name": "Monthly Revenue",
        "type": "bar"
      }
    ]
  }
}