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. 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.

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 are executing the export directly the response would be the export file.

Parameters
Expand all Reset
properties *OBJECTrequired
securable_id *UUIDrequired
type STRING
chart_id UUID
locale_id STRING
screenmode STRING
dimensions OBJECT
emails ARRAY[STRING]
schedule OBJECT
filters ARRAY[OBJECT]
Can be executed by:
Dashboard Viewer
Can be associated to:
Get Dataprovider
Search Export
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('export',
  {
    securable_id: "< Your securable id >",
    type: "pdf",
    screenmode: "desktop",
    emails: [
      "testexport@test.com"
    ],
    schedule: {
      frequency: 1440
    }
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{}