List Dashboards

List all dashboards for your organization, including the ones of parent organizations you were invited to

GET /v2/dashboard

List Dashboards

JavaScript

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v2/dashboard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "project_id": "<string>",
  "widgets": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "tab_id": "<string>",
      "config": {}
    }
  ],
  "layouts": {},
  "created_at": {},
  "updated_at": {}
}

← Dashboards API

Retrieve all dashboards for the current organization. If your organization is below another one in a group hierarchy, the dashboards of its projects that your organization was invited to are also included. Those carry only the widgets of the views your organization may see, and their revision is the revision of that part.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Response

Returns a list of dashboard objects with HTTP 200. Each item contains:

id · string

Dashboard UUID

project_id · string

UUID of the project this dashboard belongs to

widgets · array

List of widget configurations

Show Widget object

id · string

Widget identifier

name · string

Widget display name

type · string

Chart type (e.g. bar_chart, line_chart, pie_chart, table)

tab_id · string

Tab this widget belongs to

config · object

Widget configuration with metrics, periodicity, periods, and unit

layouts · object

Responsive grid layouts with breakpoints: lg, md, sm, xs, xxs

created_at · datetime

Creation timestamp (ISO 8601)

updated_at · datetime | null

Last update timestamp (ISO 8601)

Example

cURL

curl -X GET "https://api.dcycle.io/v2/dashboard" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Successful Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "project_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
    "widgets": [
      {
        "id": "widget-1",
        "name": "Carbon Footprint by Scope",
        "type": "bar_chart",
        "config": { ... }
      }
    ],
    "layouts": {
      "lg": [{ "i": "widget-1", "x": 0, "y": 0, "w": 6, "h": 4 }],
      "md": [],
      "sm": [],
      "xs": [],
      "xxs": []
    },
    "created_at": "2024-11-24T10:30:00Z",
    "updated_at": "2024-12-15T14:20:00Z"
  }
]

Response Fields

Field	Type	Description
id	UUID	Dashboard identifier
project_id	UUID	Associated project
widgets	array	List of widget configurations
layouts	object	Responsive grid layouts per breakpoint
created_at	datetime	Creation timestamp
updated_at	datetime	Last modification timestamp

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

Related Endpoints

Get Dashboard

Get a specific dashboard by ID

Create Dashboard

Create a new dashboard