Dashboards

List all dashboards

get

Retrieves a list of all dashboards accessible by the authenticated user

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Responses

200

Dashboards retrieved successfully

application/json

actionstringOptional

Action that was performed

Example: get blob list

messagestringOptional

Human-readable message (often empty on success)

statusintegerOptional

HTTP status code

Example: 200

successbooleanOptional

Operation completed successfully

Example: true

401

Unauthorized - Invalid or missing API key

get/v2/dashboards

HTTPcURLJavaScriptPython

GET /v2/dashboards HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "action": "get blob list",
  "data": {
    "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"
        ]
      }
    ]
  },
  "message": "",
  "status": 200,
  "success": true
}

Get dashboard details

get

Retrieves complete dashboard information including all widgets and their configurations. Returns widget types (chart, stat, gauge, table, etc.) with their data sources and metadata.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Path parameters

dashboard_idstringRequired

Dashboard ID (UUID format)

Example: 3e5c0246-c759-48e8-8345-27db13f11ff7

Responses

200

Dashboard retrieved successfully

application/json

actionstringOptional

Action that was performed

Example: get blob list

messagestringOptional

Human-readable message (often empty on success)

statusintegerOptional

HTTP status code

Example: 200

successbooleanOptional

Operation completed successfully

Example: true

401

Unauthorized - Invalid or missing API key

404

Dashboard not found

get/v2/dashboards/{dashboard_id}

HTTPcURLJavaScriptPython

GET /v2/dashboards/{dashboard_id} HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "action": "get blob list",
  "data": {
    "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"
      }
    ]
  },
  "message": "",
  "status": 200,
  "success": true
}

Get devices from dashboard

get

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.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Path parameters

dashboard_idstringRequired

Dashboard ID (UUID format)

Example: 3e5c0246-c759-48e8-8345-27db13f11ff7

Responses

200

Devices retrieved successfully

application/json

actionstringOptional

Action that was performed

Example: get blob list

messagestringOptional

Human-readable message (often empty on success)

statusintegerOptional

HTTP status code

Example: 200

successbooleanOptional

Operation completed successfully

Example: true

401

Unauthorized - Invalid or missing API key

404

Dashboard not found

get/v2/dashboards/{dashboard_id}/devices

HTTPcURLJavaScriptPython

GET /v2/dashboards/{dashboard_id}/devices HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "action": "get blob list",
  "data": {
    "devices": [
      {
        "device_id": "text",
        "device_name": "text",
        "project_id": "text",
        "project_name": "text"
      }
    ]
  },
  "message": "",
  "status": 200,
  "success": true
}

Invite users/groups to dashboard

post

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:

Role	Permissions
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-management permission on the dashboard

• Organization plan required for group invitations

• Users must exist in your organization

• Role must be a valid dashboard role ID

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Path parameters

dashboard_idstringRequired

Dashboard ID (UUID format)

Example: 3e5c0246-c759-48e8-8345-27db13f11ff7

Body

application/json

Responses

200

Invitation sent successfully - Users will receive email notifications

application/json

actionstringOptional

Action that was performed

Example: delete device

messagestringOptional

Human-readable success message

Example: Operation completed successfully

statusintegerOptional

HTTP status code

Example: 200

successbooleanOptional

Operation completed successfully

Example: true

400

Invalid request body - Check email format and role values (must be: owner, admin, readwrite, readonly, or custom role ID)

application/json

401

Unauthorized - Invalid or missing API key

application/json

404

Dashboard not found or access denied

application/json

post/v2/dashboards/{dashboard_id}/invite

HTTPcURLJavaScriptPython

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": "[e-mail]",
      "role": "readwrite"
    }
  ]
}

{
  "action": "delete device",
  "message": "Operation completed successfully",
  "status": 200,
  "success": true
}