Dissociate Dashboard

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/securable

Datasets and dashboards are in the Luzmo API a type of securable . As such, the API calls to create, update, delete, ... datasets or dashboards are executed against the securable endpoint.

Properties relevant to one, may not be relevant to the other. Those will be null (e.g. contents is null for a dataset while for dashboards it is one of the most important properties as it holds the definition of screenmodes, charts, ...).

Dashboards can be created, retrieved, updated and associated programmatically.

The dashboard definition itself is configured via a json object in the contents property. This json object defines per view modus which visualization elements that are contained within the dashboard and what position and data connections each of them have. It is important to notice that the structure of this json evolves as we add new visualization types or adapt existing ones. That is why the json starts by declaring the version of the dashboard config. This makes sure that we are backward compatible with dashboard configurations that are created according to an older structure. Although it is possible, typically users do not create a dashboard from scratch. If you want to learn more about this structure, we advice to make a dashboard via the UI and retrieve it via the API to see what it looks like. A common use case is to create dashboards via the editor and add a logo or change colors programmatically.

Request parametersResponse schema
id UUID

The unique identifier of the entity

name Multilingual string

Internationalized title of the dashboard.

description Multilingual string

Internationalized description of the dashboard.

ai_context STRING

Plain-text AI context for this dashboard. Use this field to store dashboard-level business context for AI-enabled workflows. It enriches, but does not replace, the dashboard name and description. This field is shared across all languages and is not internationalized. Set it to null to clear previously stored AI context. The API stores and returns the full value.

subtitle Multilingual string

Internationalized subtitle of the dashboard.

custom_metadata OBJECT

Custom metadata attached to this dashboard. Must be a valid JSON object with a maximum size of 65536 bytes. Set to null to clear previously stored metadata.

type STRING
No description available
subtype STRING

Immutable subtype identifying the dashboard's source or specialization.

storage STRING

Storage backend used by the dashboard record. This property is read-only.

rows NUMBER

Number of rows stored for the securable record. For dashboards this is normally 0 .

dimensions OBJECT

Calculated dashboard dimensions by screen mode, derived from the dashboard contents.

chartDimensions OBJECT

Calculated dimensions for dashboard items and screen modes, derived from the dashboard contents.

css STRING

CSS code that overrides styling in the dashboard. Example: .pivottable-value { font-size: 18px; }. Defaults to null.

contents OBJECT
No description available
is_variant BOOLEAN
No description available
created_at DATETIME

RFC 3339 date time string indicating when the resource was created

updated_at DATETIME

RFC 3339 date time string indicating when the resource was last updated

modified_at DATETIME

RFC 3339 date time string indicating when the dashboard's contents were last modified. This can differ from updated_at , which tracks changes to the dashboard record itself.

owner_id STRING

ID of the user that owns this dashboard.

Can be executed by:
Securable Owner
&
Organization Editor
(For: Users)
Securable Owner
&
Group Member
(For: Groups)
Securable Reader
&
Securable Reader
(For: favorites)
Securable User
&
Securable User
(For: variants)
Securable User
&
Securable User
(For: original)
Securable Modifier
&
Organization Member
(For: Tags)
Securable Modifier
&
Securable Modifier
(For: Schedule)
Securable Reader
&
Entity Modifier
(For: Collections)
Securable Owner
&
Entity Modifier
(For: Share)
Securable Owner
&
Entity Modifier
(For: Integrations)
Can be associated to:
Groups
Users
favorites
variants
original
Tags
Schedule
Collections
Share
Integrations
SecurableVersion
Thumbnail
Datasets
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});

const response = await client.dissociate('securable',
  '<your dashboard id>',
  { role: '<the resource>', id: '<the resource id>' }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "rows": 0,
  "featured": false,
  "modified_at": "2024-03-28T09:24:17.444Z",
  "cache": 0,
  "storage": "clickhouse",
  "uses_clickhouse_experimental": false,
  "meta_sync_interval": 1,
  "meta_sync_inherit": true,
  "meta_sync_enabled": true,
  "name": {
    "en": "Test dashboard"
  },
  "description": {
    "en": "This is a test dashboard"
  },
  "ai_context": null,
  "custom_metadata": {
    "owner": "analytics",
    "nested": {
      "level": "L1"
    }
  },
  "type": "dashboard",
  "id": "aafca78a-0f21-41ae-862e-7e46a511c800",
  "updated_at": "2024-03-28T09:24:17.570Z",
  "created_at": "2024-03-28T09:24:17.450Z",
  "subtitle": null,
  "contents": {
    "version": "0.1.99",
    "syncScreenModes": true,
    "datasetLinks": {},
    "views": [
      {
        "screenModus": "desktop",
        "options": {
          "share": {
            "poweredBy": false
          },
          "theme": {
            "id": "default"
          },
          "alertingEnabled": true
        },
        "filterGroups": [],
        "items": []
      },
      {
        "screenModus": "tablet",
        "options": {
          "share": {
            "poweredBy": false
          },
          "theme": {
            "id": "default"
          },
          "alertingEnabled": true
        },
        "filterGroups": [],
        "items": []
      },
      {
        "screenModus": "mobile",
        "options": {
          "share": {
            "poweredBy": false
          },
          "theme": {
            "id": "default"
          },
          "alertingEnabled": true
        },
        "filterGroups": [],
        "items": []
      }
    ],
    "parameters": [],
    "timezone": {
      "type": "fixed",
      "id": "UTC"
    }
  },
  "css": null,
  "source_dataset": null,
  "source_sheet": null,
  "source_query": null,
  "transformation": null,
  "is_variant": false,
  "migrated_rows": null,
  "last_metadata_sync_at": null,
  "last_metadata_sync_attempt_at": "2024-03-28T09:24:17.488Z",
  "acceleration_id": null,
  "account_id": null,
  "template_id": null,
  "original_id": null,
  "modifier_id": "34b22f36-4904-497f-8acf-b0ba1d7e83cb",
  "owner_id": "34b22f36-4904-497f-8acf-b0ba1d7e83cb",
  "source_template_id": null
}