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));import requests
url = "https://api.dcycle.io/v2/dashboard"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v2/dashboard \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "<string>",
"project_id": "<string>",
"widgets": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"tab_id": "<string>",
"config": {}
}
],
"layouts": {},
"created_at": {},
"updated_at": {}
}List Dashboards
List all dashboards for your organization, including shared parent dashboards
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));import requests
url = "https://api.dcycle.io/v2/dashboard"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v2/dashboard \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"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 a child in a group hierarchy, dashboards shared by parent organizations are also included.
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faResponse
Returns a list of dashboard objects with HTTP 200. Each item contains:string
Dashboard UUID
string
UUID of the project this dashboard belongs to
array
object
Responsive grid layouts with breakpoints:
lg, md, sm, xs, xxsdatetime
Creation timestamp (ISO 8601)
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}"
import requests
import os
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
response = requests.get(
"https://api.dcycle.io/v2/dashboard",
headers=headers,
)
dashboards = response.json()
for d in dashboards:
print(f"Dashboard {d['id']} — project: {d['project_id']}, widgets: {len(d['widgets'])}")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
};
axios.get('https://api.dcycle.io/v2/dashboard', { headers })
.then(response => {
response.data.forEach(d =>
console.log(`Dashboard ${d.id} — ${d.widgets.length} widgets`)
);
});
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
Was this page helpful?