Dashboards
Retrieves a list of all dashboards accessible by the authenticated user
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Dashboards retrieved successfully
Unauthorized - Invalid or missing API key
GET /v2/dashboards HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
"dashboards": [
{
"created": "text",
"id": "text",
"is_public": true,
"last_modified": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"refresh_period": 1,
"tags": [
"text"
],
"widgets": [
"text"
]
}
]
}Retrieves complete dashboard information including all widgets and their configurations. Returns widget types (chart, stat, gauge, table, etc.) with their data sources and metadata.
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Dashboard ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Dashboard retrieved successfully
Unauthorized - Invalid or missing API key
Dashboard not found
GET /v2/dashboards/{dashboard_id} HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"is_public": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"refresh_period": 1,
"tags": [
"text"
],
"widgets": [
{
"data_metadata": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"description": "text",
"id": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"subtitle": "text",
"title": "text",
"widget_type": "text"
}
]
}Extracts unique device IDs from all widgets in the dashboard. Returns device_id, device_name, project_id, and project_name for each device. Use this information to query device data via the data endpoints. Note: Table widgets (fleet views) may not contain device_ids as they display all devices in a project.
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Dashboard ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Devices retrieved successfully
Unauthorized - Invalid or missing API key
Dashboard not found
GET /v2/dashboards/{dashboard_id}/devices HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
"devices": [
{
"device_id": "text",
"device_name": "text",
"project_id": "text",
"project_name": "text"
}
]
}Share dashboard access with users or groups in your organization. Invited members will receive email notifications and gain dashboard access based on their assigned role.
Dashboard Roles:
owner
Full control: read, write, delete, access management, widget management, tag updates
admin
Full control: same as owner (read, write, delete, access management, widget/tag management)
readwrite
Read and modify: read, write, update widgets and tags (cannot delete dashboard or manage access)
readonly
View only: read dashboard and widgets (no modifications)
Custom Roles: Organizations can create custom roles with specific permission combinations.
Prerequisites:
Must have
access-managementpermission on the dashboardOrganization plan required for group invitations
Users must exist in your organization
Role must be a valid dashboard role ID
Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"
Dashboard ID (UUID format)
3e5c0246-c759-48e8-8345-27db13f11ff7Invitation sent successfully - Users will receive email notifications
Invalid request body - Check email format and role values (must be: owner, admin, readwrite, readonly, or custom role ID)
Unauthorized - Invalid or missing API key
Dashboard not found or access denied
POST /v2/dashboards/{dashboard_id}/invite HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"groups": [
{
"id": "5f8d0d55b54764ca6f3a1234",
"role": "readwrite"
}
],
"users": [
{
"email": "[email protected]",
"role": "readwrite"
}
]
}{
"action": "delete device",
"message": "Operation completed successfully",
"success": true
}Last updated