Search Share

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/share
API call form
Examples

A share is a private link to a dashboard. Each share has a default language and its own usage statistics. The creating user is automatically linked to the Share. Besides of sharing dashboards with users that do not have a Luzmo account, another usage is to have different usage statistics for different groups of users. In other words, you can create multiple share links for a dashboard for which the owner receives separate usage statistics.

Parameters
Expand all Reset
find *OBJECTrequired
where *OBJECTrequired
attributes ARRAY[STRING]
include ARRAY[OBJECT]
order ARRAY
limit NUMBER
offset NUMBER
Can be executed by:
Logged-in User
Securable Reader
Can be associated to:
Dashboard
Locale
User
Create Share
Delete Share
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.get('share',
  {
    where: {
      id: "<your share id>"
    }
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "count": 2,
  "rows": [
    {
      "id": "cnzev2tv29yom6sr",
      "date": "2024-02-20T19:50:43.867Z",
      "created_at": "2024-02-20T19:50:43.868Z",
      "updated_at": "2024-02-20T19:50:43.956Z",
      "locale_id": "en-US",
      "securable_id": "7d8278b3-e1ef-43d0-b459-7b9f65f5be4b",
      "user_id": "444e2d0c-8dfb-45c1-bb97-52cb9264671f"
    },
    {
      "id": "lz6dmtgusy8lkvnr",
      "date": "2025-06-06T20:15:15.000Z",
      "created_at": "2024-02-20T19:52:34.239Z",
      "updated_at": "2024-02-20T20:09:13.938Z",
      "locale_id": null,
      "securable_id": "7d8278b3-e1ef-43d0-b459-7b9f65f5be4b",
      "user_id": "444e2d0c-8dfb-45c1-bb97-52cb9264671f"
    }
  ]
}