Associate Locale

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

Set the language dashboards open in by default.

Which language is used

When a dashboard opens, Luzmo takes the first of these that applies:

  1. The language property on the embed component, but only if the dashboard was actually built in that language. If it wasn't, Luzmo skips this step.

  2. The locale on the share link ( Share ).

  3. The viewer's own locale ( Users ), again only if the dashboard was actually built in that language. Viewers who don't have a locale of their own fall back to the organization default ( defaultLocale ).

  4. The first language the dashboard was built in.

If you set a locale on a share link that the dashboard was never translated into, each title and label falls back on its own: first to the viewer's language, and then to the first translation the dashboard has.

Roles

  • Users : pass a user id. Dashboards and datasets open in this language for that user, and new dashboards they create start in this language too.

  • defaultLocale : pass an organization id. Users who don't have a locale of their own see dashboards in this language.

  • Share : pass a share id. Everyone who opens that private link sees the dashboard in this language.

Embed tokens

You don't associate a locale with an embed token. Set the language on the component instead. Use the language property on the dashboard component , the locale option on the chart component , or the customization options of the chat component.

For dashboards, the component language is only used if the dashboard was built in that language. Charts follow the same idea with options.locale . The IQ chat component only looks at the locale in its options and otherwise uses English.

Request parametersResponse schema
id STRING

Unique identifier of the Locale (locale code, e.g. en-US ).

description STRING

Human-readable description of the Locale.

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

Can be executed by:
Logged-in User
&
Authorization Owner
(For: Authorization)
Logged-in User
&
Organization Owner
(For: Organization)
Logged-in User
&
Securable Owner
(For: Share)
Logged-in User
&
User Owner
(For: User)
Can be associated to:
User
Organization
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('locale',
  'fr',
  { role: 'Users', id: '<user id>' }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "fr",
  "description": "français",
  "created_at": "2014-12-14T23:00:00.000Z",
  "updated_at": "2014-12-14T23:00:00.000Z"
}