Skip to main content

Lightdash API (1.0.0)

E-mail: support@lightdash.com License: MIT

API spec for Lightdash server

user

User operation

Login with email and password

Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get user profile

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Create user

Authorizations:
cookieAuth
Request Body schema: application/json
inviteCode
required
string
firstName
required
string
lastName
required
string
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "inviteCode": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Get all personal access tokens

List all personal access tokens for user

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Create a personal access token

Authorizations:
cookieAuth
Request Body schema: application/json

Personal access token

expiresAt
string <date-time>
description
required
string

Responses

Request samples

Content type
application/json
{
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

organization

Update organization

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get organization users

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Delete organization project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

List organization projects

Authorizations:
cookieAuth
Request Body schema: application/json
role
string

Responses

Request samples

Content type
application/json
{
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Update organization member

Authorizations:
cookieAuth
path Parameters
userUuid
required
string <uuid>
Request Body schema: application/json
role
string

Responses

Request samples

Content type
application/json
{
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "userUuid": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}

Delete organization user

Authorizations:
cookieAuth
path Parameters
userUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

project

Delete organization project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

List organization projects

Authorizations:
cookieAuth
Request Body schema: application/json
role
string

Responses

Request samples

Content type
application/json
{
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Run sql query

Run a sql query on project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
Request Body schema: application/json

Sql

sql
required
string

Responses

Request samples

Content type
application/json
{
  • "sql": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "rows": [
    ]
}

Run query

Run a query on project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
tableId
required
string
Request Body schema: application/json

query

metrics
required
Array of arrays
dimensions
required
Array of arrays
limit
number
sorts
Array of arrays
tableCalculations
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "metrics": [ ],
  • "dimensions": [ ],
  • "limit": 0,
  • "sorts": [ ],
  • "tableCalculations": [ ]
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Get project catalog

Get project catalog with all valid tables

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Get project tables configuration

Get project tables configuration

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Update project tables configuration

Update project tables configuration

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
Request Body schema: application/json

New tables configuration

required
object
type
required
string
Enum: "ALL" "WITH_TAGS" "WITH_NAMES"
value
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "tableSelection": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

dashboard

Create dashboard

Create new dashboard on project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
query Parameters
duplicateFrom
string <uuid>
Request Body schema: application/json

New dashboard specification

name
string
description
string or null
Array of objects (CreateDashboardTile)
object (DashboardFilters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tiles": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

List dashboards

List all dashboards in a project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
query Parameters
chartUuid
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Get dashboard

Get details for a single dashboard by dashboard_id

Authorizations:
cookieAuth
path Parameters
dashboardUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Update dashboard

Update details for a single dashboard by dashboard_id

Authorizations:
cookieAuth
path Parameters
dashboardUuid
required
string <uuid>
Request Body schema: application/json

Dashboard fields

One of
name
string
description
string or null
spaceUuid
string or null

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "spaceUuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Delete dashboard

Delete a single dashboard by dashboard_id

Authorizations:
cookieAuth
path Parameters
dashboardUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

saved

Create saved chart in project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
query Parameters
duplicateFrom
string <uuid>
Request Body schema: application/json
name
string
description
string
tableName
string
metricQuery
object
object (ChartConfig)
object
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tableName": "string",
  • "metricQuery": { },
  • "chartConfig": {
    },
  • "tableConfig": {
    },
  • "pivotConfig": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Update multiple saved charts in project

Authorizations:
cookieAuth
path Parameters
projectUuid
required
string <uuid>
Request Body schema: application/json
Array
uuid
string
name
string
description
string or null
spaceUuid
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

Get a saved chart

Authorizations:
cookieAuth
path Parameters
savedChartUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Delete a saved chart

Authorizations:
cookieAuth
path Parameters
savedChartUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update a saved chart

Authorizations:
cookieAuth
path Parameters
savedChartUuid
required
string <uuid>
Request Body schema: application/json

Saved chart name

name
string
description
string or null
spaceUuid
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spaceUuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

Create a new saved chart version

Authorizations:
cookieAuth
path Parameters
savedChartUuid
required
string <uuid>
Request Body schema: application/json
tableName
required
string
metricQuery
required
object
required
object (ChartConfig)
required
object
object

Responses

Request samples

Content type
application/json
{
  • "tableName": "string",
  • "metricQuery": { },
  • "chartConfig": {
    },
  • "tableConfig": {
    },
  • "pivotConfig": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}

saved-chart

Get available filters for a saved chart

Authorizations:
cookieAuth
path Parameters
savedChartUuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": [
    ]
}

job

List status of a job

Authorizations:
cookieAuth
path Parameters
jobUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "results": {
    }
}