Lightdash

Lightdash v2 API

The v2 API from Lightdash — 47 operation(s) for v2.

GitHub OpenAPI

Operations 59

GET /api/v2/projects/{projectUuid}/pre-aggregates/stats Get pre-aggregate stats #
GET /api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit Get dashboard pre-aggregate audit #
POST /api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit Run dashboard pre-aggregate audit #
GET /api/v2/projects/{projectUuid}/pre-aggregates/materializations Get pre-aggregate materializations #
POST /api/v2/orgs/{orgUuid}/roles Create custom role #
GET /api/v2/orgs/{orgUuid}/roles Get organization roles #
PATCH /api/v2/orgs/{orgUuid}/roles/{roleUuid} Update custom role #
DELETE /api/v2/orgs/{orgUuid}/roles/{roleUuid} Delete custom role #
GET /api/v2/orgs/{orgUuid}/roles/{roleUuid} Get custom role #
GET /api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees List role assignees #
POST /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes Add scopes to role #
DELETE /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName} Remove scope from role #
GET /api/v2/projects/{projectId}/roles/assignments List project role assignments #
POST /api/v2/projects/{projectId}/roles/assignments/user/{userId} Assign project role to user #
DELETE /api/v2/projects/{projectId}/roles/assignments/user/{userId} Remove project role from user #
POST /api/v2/projects/{projectId}/roles/assignments/group/{groupId} Assign project role to group #
PATCH /api/v2/projects/{projectId}/roles/assignments/group/{groupId} Update project group role #
DELETE /api/v2/projects/{projectId}/roles/assignments/group/{groupId} Remove project role from group #
GET /api/v2/orgs/{orgUuid}/roles/assignments List organization role assignments #
POST /api/v2/orgs/{orgUuid}/roles/assignments/user/{userId} Assign organization role to user #
POST /api/v2/orgs/{orgUuid}/roles/{roleId}/duplicate Duplicate role #
GET /api/v2/projects/{projectUuid}/validate List validation results #
GET /api/v2/projects/{projectUuid}/validate/{validationIdOrUuid} Get validation result #
GET /api/v2/saved/{chartUuid}/schedulers List chart schedulers #
GET /api/v2/saved/{chartUuid}/schedulers/{schedulerUuid}/runs List chart scheduler runs #
GET /api/v2/projects/{projectUuid}/query/{queryUuid} Get results #
POST /api/v2/projects/{projectUuid}/query/{queryUuid}/cancel Cancel query #
POST /api/v2/projects/{projectUuid}/query/{queryUuid}/calculate-total Calculate totals #
POST /api/v2/projects/{projectUuid}/query/metric-query Execute metric query #
POST /api/v2/projects/{projectUuid}/query/field-values Search field values #
POST /api/v2/projects/{projectUuid}/query/chart Execute saved chart #
POST /api/v2/projects/{projectUuid}/query/dashboard-chart Execute dashboard chart #
POST /api/v2/projects/{projectUuid}/query/underlying-data Execute underlying data #
POST /api/v2/projects/{projectUuid}/query/sql Execute SQL query #
POST /api/v2/projects/{projectUuid}/query/sql-chart Execute SQL chart #
POST /api/v2/projects/{projectUuid}/query/dashboard-sql-chart Execute dashboard SQL chart #
POST /api/v2/projects/{projectUuid}/query/{queryUuid}/download Download results #
POST /api/v2/projects/{projectUuid}/query/{queryUuid}/schedule-download Download results #
GET /api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug} Get chart #
DELETE /api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug} Delete chart #
GET /api/v2/projects/{projectUuid}/defaults Get project defaults #
PUT /api/v2/projects/{projectUuid}/defaults Replace project defaults #
GET /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug} Get dashboard #
PATCH /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug} Update dashboard #
DELETE /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug} Delete dashboard #
GET /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}/comments Get comments #
GET /api/v2/projects/{projectUuid}/parameters/list List project parameters #
GET /api/v2/projects/{projectUuid}/parameters Get project parameters #
PUT /api/v2/projects/{projectUuid}/parameters Replace project parameters #
GET /api/v2/feature-flag/{featureFlagId} Get feature flag #
GET /api/v2/dashboards/{dashboardUuid}/schedulers List dashboard schedulers #
GET /api/v2/dashboards/{dashboardUuid}/schedulers/{schedulerUuid}/runs List dashboard scheduler runs #
GET /api/v2/content List content #
POST /api/v2/content/{projectUuid}/move Move content #
POST /api/v2/content/bulk-action/{projectUuid}/move Bulk move content #
GET /api/v2/content/deleted List deleted content #
POST /api/v2/content/{projectUuid}/restore Restore content #
DELETE /api/v2/content/{projectUuid}/permanent Permanently delete content #
GET /api/v2/projects/{projectUuid}/dataCatalog/metrics-with-time-dimensions List metrics with time dimensions #

Documentation

📖
Documentation
https://docs.lightdash.com/api-reference/v1/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-v2-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-project.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-dashboard.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-chartsummary.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-space.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-scimuser.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-serviceaccount.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-schedulerandtargets.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-apierrorpayload.json

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/vocabulary/lightdash-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-ld/lightdash-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightdash-v2-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightdash-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightdash V2 API
  version: 0.3156.1
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens'
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:


# --- truncated at 32 KB (280 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-v2-api-openapi.yml