Associate Share

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

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.

Shares are automatically connected to the users that make them. Besides of that, they have to be associated to the dashboard that they share and can optionally be associated to a locale in order to set the default locale for the share. In order to make a private share link work you also have to make sure that you dashboards and the datasets that are used are associated with the public group.

Creating a share and associating it to a dashboard makes it possible to share private links with users.

A user is allowed to link a locale to a share in case the user is owner of the dashboard that is shared in the link. Associating a locale with the share will make sure that all users that open the dashboard via this link will see it in that specific locale. You can make multiple share links for a dashboard with different locales in case you need to send private links to a mixed audience.

This is a special case similar to many entities that are linked to user. When creating a private link to a dashboard, the creating user is automatically linked to the Share. Note that the code on the right only creates a link which is not yet linked to a dashboard.

Parameters
Expand all Reset
id *STRINGrequired

Unique character key of the share (automatically assigned)

resource *OBJECTrequired
role *STRINGrequired
id *STRINGrequired
Can be executed by:
Share Owner
&
Securable Owner
(For: Dashboard)
Logged-in User
&
Securable Owner
(For: Locale)
Can be associated to:
Dashboard
Locale
User
Delete Share
Dissociate 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.associate('share',
  '<your share id>',
  { role: 'Locale', id: 'fr' }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "lz6dmtgusy8lkvnr",
  "date": "2024-05-26T23:15:15.000Z",
  "created_at": "2024-02-20T19:52:34.239Z",
  "updated_at": "2024-02-20T19:59:06.112Z",
  "locale_id": "fr",
  "securable_id": "7d8278b3-e1ef-43d0-b459-7b9f65f5be4b",
  "user_id": "444e2d0c-8dfb-45c1-bb97-52cb9264671f"
}