Create Export

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/export

API call form

Examples

List of examples

Create scheduled email export
Create export with customized message
Create scheduled CSV export of a certain chart
Create Flex chart PNG export
Create Flex chart PNG export with filters

Description

Export an ad-hoc Flex chart with data filters applied. Filters must be provided inside the item object using the FilterGroup structure. Top-level filters are not supported for Flex exports.

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

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('export',
  {
    type: "png",
    item: {
      type: "bar-chart",
      slots: [
        {
          name: "measure",
          content: [
            {
              label: "Total Revenue",
              datasetId: "< dataset id >",
              columnId: "< measure column id >",
              aggregationFunc: "sum"
            }
          ]
        },
        {
          name: "y-axis",
          content: [
            {
              label: "Region",
              datasetId: "< dataset id >",
              columnId: "< category column id >"
            }
          ]
        }
      ],
      filters: [
        {
          condition: "and",
          filters: [
            {
              expression: "? = ?",
              parameters: [
                {
                  datasetId: "< dataset id >",
                  columnId: "< filter column id >"
                },
                "Europe"
              ]
            }
          ],
          subGroups: [

          ]
        }
      ]
    },
    dimensions: {
      width: 800,
      height: 600
    }
  }
);