Get Hierarchy

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

The current structure of the hierarchy can be retrieved as a tree via the get call.

Per element you can see:

  1. Languages (translations) for your column values.

  2. A specific data-driven color for a value.

  3. The hierarchy tree structure of your column values.

Virtual vs value elements

There are two types of hierarchy elements:

  • Values: elements that have an 'id' that matches with an existing 'data' value or that will match with a future data value in the column.

  • Virtuals: elements that are not occurring in the dataset ('virtual elements'), these are categories which are used to build the structure of a tree.

Virtual nodes

Parameters
Expand all Reset
find *OBJECTrequired
where *OBJECTrequired
attributes ARRAY[STRING]
include ARRAY[OBJECT]
order ARRAY
limit NUMBER
offset NUMBER
Can be executed by:
Entity Reader
Can be associated to:
Create Generate Descriptions
Update Hierarchy
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('hierarchy',
  {
    where: {
      securable_id: "<your dataset id>",
      column_id: "<your column id>"
    }
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
[
  {
    "id": "",
    "name": {
      "nl": "Alle",
      "fr": "Tout",
      "en": "All"
    },
    "color": "#ccc",
    "virtual": true,
    "children": [
      {
        "id": "Navigation",
        "name": {
          "nl": "Navigation",
          "fr": "Navigation",
          "en": "Navigation"
        },
        "color": null,
        "virtual": false,
        "children": [],
        "order_index": null,
        "tree_order_index": 0.5,
        "trace": [
          "",
          "Navigation"
        ]
      },
      {
        "id": "e11b7b80-ac61-11e8-9e69-c3648c19dd02",
        "name": {
          "en": "Objects1"
        },
        "color": null,
        "virtual": true,
        "children": [
          {
            "id": "Safety",
            "name": {
              "nl": "Safety",
              "fr": "Safety",
              "en": "Safety"
            },
            "color": null,
            "virtual": false,
            "children": [],
            "order_index": null,
            "tree_order_index": 9,
            "trace": [
              "",
              "e11b7b80-ac61-11e8-9e69-c3648c19dd02",
              "Safety"
            ]
          }
        ]
      }
    ]
  }
]