Create Export

LLM-friendly URL

POST

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

API call form

Examples

Export is a service that will either: create a PNG or PDF export of a dashboard or an individual chart, CSV of an individual chart, or create a PNG or PDF export of an ad-hoc Flex chart definition (without a saved dashboard). It can also create a Schedule that sends an e-mail regularly. So this service is an easier way to create/get/delete export schedules. These schedules can also be retrieved with the Schedule endpoint.

There are two mutually exclusive export modes: Saved Dashboard/Chart Export (using securable_id ) supports PNG, PDF, and CSV types, while Flex Chart Export (using item ) supports only PNG and PDF types.

Any dashboard viewer can create exports of dashboards and charts, or set up scheduled exports. Dashboard modifiers can modify and delete any scheduled exports for their dashboards, even if they did not create them initially.

If the schedule property is defined, you get a schedule in the response. If you execute the export directly, the response contains the export file.

Parameters

Expand all

Reset

Can be executed by:

Dashboard Viewer

Can be associated to:

Did this page help you?

Yes

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('export',
  {
    securable_id: "< Your dashboard id >",
    type: "pdf",
    screenmode: "desktop",
    emails: [
      "testexport@test.com"
    ],
    schedule: {
      frequency: 1440
    }
  }
);

Example Response

200

400

500

{}