How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightdash Project API

The Project API from Lightdash — 3 operation(s) for project.

Lightdash Project API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.

Requests are made against a single base URL, /.

3 operations 3 paths 13 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash Project API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Project 3
POST
/api/v2/projects/{projectUuid}/deploy
Start deploy session
startDeploySession 1 param → 200default
POST
/api/v2/projects/{projectUuid}/deploy/{sessionUuid}/batch
Add deploy batch
addDeployBatch 2 params body → 200default
POST
/api/v2/projects/{projectUuid}/deploy/{sessionUuid}/finalize
Finalize deploy
finalizeDeploySession 2 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ExploreWarningReport (3 properties), ApiFinalizeDeployResponse (2 properties), ApiDeployExploresResults (2 properties), ApiAddDeployBatchResponse (2 properties). Each schema is shown below with its type and property counts.

ApiFinalizeDeployResponse
object
2 properties 2 required
Pick_Explore.name_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
ExploreWarningReport
object
3 properties 3 required
InlineErrorType
string
DeploySessionStatus
string
InlineError
object
2 properties 2 required
ExploreWarningSummary
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
ApiAddDeployBatchResponse
object
2 properties 2 required
ApiDeployExploresResults
object
2 properties 2 required
NonNullable_Explore-at-warnings_
Exclude null and undefined from T
ApiStartDeploySessionResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-project-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
Where this information came from

This is an independent, third-party profile of Lightdash Project API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.