Skip to main content
GET
/
v2
/
dashboard
List Dashboards
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));
{
  "id": "<string>",
  "project_id": "<string>",
  "widgets": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "tab_id": "<string>",
      "config": {}
    }
  ],
  "layouts": {},
  "created_at": {},
  "updated_at": {}
}

​
List Dashboards

Retrieve all dashboards for the current organization. If your organization is a child in a group hierarchy, dashboards shared by parent organizations are also included.

​
Request

​
Headers

​
x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
​
x-organization-id
string
required
Your organization UUIDExample: 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
​
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 -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

FieldTypeDescription
idUUIDDashboard identifier
project_idUUIDAssociated project
widgetsarrayList of widget configurations
layoutsobjectResponsive grid layouts per breakpoint
created_atdatetimeCreation timestamp
updated_atdatetimeLast 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"}

Get Dashboard

Get a specific dashboard by ID

Create Dashboard

Create a new dashboard