Create Formula

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

Create a new formula.

After creating the formula, associate it to a specific dataset (Securable).

Note: during creation of formula, expressions will be validated. You can also validate the expression before creation using the validate action.

We support following functions in expression:

  • AVG({<dataset ID>:<column ID>})

  • COUNT({<dataset ID>:<column ID>})

  • COUNTD({<dataset ID>:<column ID>})

  • COUNTR()

  • MAX({<dataset ID>:<column ID>})

  • MIN({<dataset ID>:<column ID>})

  • SUM({<dataset ID>:<column ID>})

Example: 

"expression": "AVG({69c36023-f791-4225-a6cb-b093ac598a70:6a71afc0-c95c-4d8b-8a99-c9c568d83f53})"
Parameters
Expand all Reset
properties *OBJECTrequired
id UUID
name Multilingual string
description Multilingual string
expression STRING
type STRING
subtype STRING
format STRING
informat STRING
lowestLevel NUMBER
currency_id STRING
created_at DATETIME
updated_at DATETIME
Can be executed by:
Logged-in User
Can be associated to:
Currency
Dataset
User
Validate Formula
Search Formula
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.create('formula',
  {
    expression: "AVG({69c36023-f791-4225-a6cb-b093ac598a70:6a71afc0-c95c-4d8b-8a99-c9c568d83f53})",
    name: {
      en: "avg_uniq_id"
    },
    description: {
      en: "Calculated average of unique ID"
    }
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "count": 1,
  "rows": [
    {
      "created_at": "2024-05-20T12:44:23.163Z",
      "currency_id": null,
      "description": {
        "en": "Calculated average of unique ID"
      },
      "expression": "AVG({69c36023-f791-4225-a6cb-b093ac598a70:6a71afc0-c95c-4d8b-8a99-c9c568d83f53})",
      "format": ",.2af",
      "id": "b3ad615a-5199-4e58-8e0e-73dceba18af0",
      "informat": "numeric",
      "lowestLevel": 0,
      "name": {
        "en": "avg_uniq_id"
      },
      "subtype": null,
      "type": "numeric",
      "updated_at": "2024-05-20T13:29:37.273Z",
      "user_id": "34b22f36-4904-497f-8acf-b0ba1d7e83cb"
    }
  ]
}