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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightdash

Lightdash v2 API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightdash v2 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 V2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

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

Requests are made against a single base URL, /.

59 operations 47 paths 465 schemas 7 DELETE25 GET3 PATCH22 POST2 PUT

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
Contact
Lightdash Support
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash v2 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 59

Across 47 paths, the API surfaces 59 operations — 7 DELETE, 25 GET, 3 PATCH, 22 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

v2 59
GET
/api/v2/projects/{projectUuid}/pre-aggregates/stats
Get pre-aggregate stats
getPreAggregateStats 6 params → 200default
GET
/api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit
Get dashboard pre-aggregate audit
getDashboardPreAggregateAudit 2 params → 200default
POST
/api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit
Run dashboard pre-aggregate audit
runDashboardPreAggregateAudit 2 params body → 200default
GET
/api/v2/projects/{projectUuid}/pre-aggregates/materializations
Get pre-aggregate materializations
getPreAggregateMaterializations 3 params → 200default
POST
/api/v2/orgs/{orgUuid}/roles
Create custom role
CreateOrganizationRole 1 param body → 201default
GET
/api/v2/orgs/{orgUuid}/roles
Get organization roles
GetOrganizationRoles 3 params → 200default
PATCH
/api/v2/orgs/{orgUuid}/roles/{roleUuid}
Update custom role
UpdateOrganizationRole 2 params body → 200default
DELETE
/api/v2/orgs/{orgUuid}/roles/{roleUuid}
Delete custom role
DeleteOrganizationRole 2 params → 200default
GET
/api/v2/orgs/{orgUuid}/roles/{roleUuid}
Get custom role
GetCustomRoleByUuid 2 params → 200default
GET
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees
List role assignees
GetOrganizationRoleAssignees 2 params → 200default
POST
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopesdeprecated
Add scopes to role
AddScopesToRole 2 params body → 200default
DELETE
/api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName}deprecated
Remove scope from role
RemoveScopeFromRole 3 params → 200default
GET
/api/v2/projects/{projectId}/roles/assignments
List project role assignments
GetProjectRoleAssignments 1 param → 200default
POST
/api/v2/projects/{projectId}/roles/assignments/user/{userId}
Assign project role to user
UpsertProjectUserRoleAssignment 2 params body → 200default
DELETE
/api/v2/projects/{projectId}/roles/assignments/user/{userId}
Remove project role from user
DeleteProjectUserRoleAssignment 2 params → 200default
POST
/api/v2/projects/{projectId}/roles/assignments/group/{groupId}
Assign project role to group
UpsertProjectGroupRoleAssignment 2 params body → 200default
PATCH
/api/v2/projects/{projectId}/roles/assignments/group/{groupId}
Update project group role
UpdateProjectGroupRoleAssignment 2 params body → 200default
DELETE
/api/v2/projects/{projectId}/roles/assignments/group/{groupId}
Remove project role from group
DeleteProjectGroupRoleAssignment 2 params → 200default
GET
/api/v2/orgs/{orgUuid}/roles/assignments
List organization role assignments
GetOrganizationRoleAssignments 1 param → 200default
POST
/api/v2/orgs/{orgUuid}/roles/assignments/user/{userId}
Assign organization role to user
UpsertOrganizationUserRoleAssignment 2 params body → 200default
POST
/api/v2/orgs/{orgUuid}/roles/{roleId}/duplicate
Duplicate role
DuplicateRole 2 params body → 201default
GET
/api/v2/projects/{projectUuid}/validate
List validation results
ListValidationResults 10 params → 200default
GET
/api/v2/projects/{projectUuid}/validate/{validationIdOrUuid}
Get validation result
GetValidationResult 2 params → 200default
GET
/api/v2/saved/{chartUuid}/schedulers
List chart schedulers
getSavedChartSchedulers 6 params → 200default
GET
/api/v2/saved/{chartUuid}/schedulers/{schedulerUuid}/runs
List chart scheduler runs
getSavedChartSchedulerRuns 9 params → 200default
GET
/api/v2/projects/{projectUuid}/query/{queryUuid}
Get results
getAsyncQueryResults 4 params → 200default
POST
/api/v2/projects/{projectUuid}/query/{queryUuid}/cancel
Cancel query
cancelAsyncQuery 2 params → 200default
POST
/api/v2/projects/{projectUuid}/query/{queryUuid}/calculate-total
Calculate totals
executeAsyncCalculateTotal 2 params body → 200default
POST
/api/v2/projects/{projectUuid}/query/metric-query
Execute metric query
executeAsyncMetricQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/field-values
Search field values
executeAsyncFieldValueSearch 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/chart
Execute saved chart
executeAsyncSavedChartQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/dashboard-chart
Execute dashboard chart
executeAsyncDashboardChartQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/underlying-data
Execute underlying data
executeAsyncUnderlyingDataQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/sql
Execute SQL query
executeAsyncSqlQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/sql-chart
Execute SQL chart
executeAsyncSqlChartQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/dashboard-sql-chart
Execute dashboard SQL chart
executeAsyncDashboardSqlChartQuery 1 param body → 200default
POST
/api/v2/projects/{projectUuid}/query/{queryUuid}/downloaddeprecated
Download results
downloadResults 2 params body → 200default
POST
/api/v2/projects/{projectUuid}/query/{queryUuid}/schedule-download
Download results
scheduleDownloadResults 2 params body → 200default
GET
/api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug}
Get chart
getProjectSavedChart 2 params → 200default
DELETE
/api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug}
Delete chart
deleteProjectSavedChart 2 params → 200default
GET
/api/v2/projects/{projectUuid}/defaults
Get project defaults
getProjectDefaults 1 param → 200default
PUT
/api/v2/projects/{projectUuid}/defaults
Replace project defaults
replaceProjectDefaults 1 param body → 200default
GET
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Get dashboard
getProjectDashboard 2 params → 200default
PATCH
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Update dashboard
updateProjectDashboard 2 params body → 200default
DELETE
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}
Delete dashboard
deleteProjectDashboard 2 params → 200default
GET
/api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}/comments
Get comments
getProjectDashboardComments 3 params → 200default
GET
/api/v2/projects/{projectUuid}/parameters/list
List project parameters
getProjectParametersList 6 params → 200default
GET
/api/v2/projects/{projectUuid}/parameters
Get project parameters
getProjectParameters 2 params → 200default
PUT
/api/v2/projects/{projectUuid}/parameters
Replace project parameters
replaceProjectParameters 1 param body → 200default
GET
/api/v2/feature-flag/{featureFlagId}
Get feature flag
Get feature flag 1 param → 200default
GET
/api/v2/dashboards/{dashboardUuid}/schedulers
List dashboard schedulers
getDashboardSchedulers 5 params → 200default
GET
/api/v2/dashboards/{dashboardUuid}/schedulers/{schedulerUuid}/runs
List dashboard scheduler runs
getDashboardSchedulerRuns 9 params → 200default
GET
/api/v2/content
List content
List content 9 params → 200default
POST
/api/v2/content/{projectUuid}/move
Move content
Move content 1 param body → 200default
POST
/api/v2/content/bulk-action/{projectUuid}/move
Bulk move content
Bulk move content 1 param body → 200default
GET
/api/v2/content/deleted
List deleted content
List deleted content 6 params → 200default
POST
/api/v2/content/{projectUuid}/restore
Restore content
Restore content 1 param body → 200default
DELETE
/api/v2/content/{projectUuid}/permanent
Permanently delete content
Permanently delete content 1 param body → 200default
GET
/api/v2/projects/{projectUuid}/dataCatalog/metrics-with-time-dimensions
List metrics with time dimensions
getPaginatedMetricsWithTimeDimensions 8 params → 200default

Schemas 465

The contract defines 465 schemas that model the data the API accepts and returns. The most detailed are Metric (33 properties), SavedChart (28 properties), Dashboard (27 properties), MapChart (26 properties). Each schema is shown below with its type and property counts.

OrganizationMemberRole
string
Pick_CreateDashboard.tiles-or-filters-or-parameters-or-updatedByUser-or-tabs-or-config_
object
From T, pick a set of properties whose keys are in the union K
6 properties 2 required
ResolvedProjectColorPalette
object
5 properties 5 required
KnexPaginatedData_ProjectParameterSummary-Array_
object
2 properties 1 required
Pick_CompiledDimension.name-or-label-or-table_
object
From T, pick a set of properties whose keys are in the union K
MapHexbinSizingMode
string
MarkLine
object
4 properties 1 required
TilePreAggregateAuditMiss
object
8 properties 8 required
QueryResultsPerformance
object
3 properties 3 required
FilterGroup
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
DeletedContentWithDescendants
PivotReference
object
2 properties 1 required
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
QueryWarning
object
3 properties 1 required
ContentActionMove
object
2 properties 2 required
DashboardChartTileProperties
object
2 properties 2 required
ValidationErrorType
string
ProjectMemberRole
string
QueryHistoryStatus.QUEUED
string
TreemapChart
object
10 properties
ApiGetAsyncQueryResults
Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_
object
Construct a type with a set of properties K of type T
DashboardDataAppTile
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
ProjectParameterSummary
object
4 properties 3 required
ApiGetProjectParametersListResults
DownloadFileType
string
CartesianSeriesType
string
FrameBoundaryType
string
SchedulerCsvOptions
object
4 properties 2 required
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
DashboardFilterRule
CacheMetadata
object
5 properties 1 required
BinRange
object
2 properties
FilterGroupItem
PivotValue
object
2 properties 2 required
MetricOverrides
object
SortBy
array
QueryHistoryStatus.ERROR
string
SchedulerBase
object
26 properties 19 required
LegendPlacement
string
High-level legend placement preset. Set to 'outsideRight' or 'outsideLeft' to render the legend beside the plot with reserved grid space. Undefined behaves lik…
CatalogItemIcon
Filters
object
3 properties
ApiContentResponse
object
2 properties 2 required
UpdateRole
object
3 properties
AdditionalMetric
object
23 properties 4 required
ApiSuccess_ApiExecuteAsyncSqlQueryResults_
object
2 properties 2 required
ExecuteAsyncDashboardSqlChartRequestParams
Source
object
4 properties 3 required
FrameBoundary
object
2 properties 1 required
Record_string.ResultColumn_
object
Construct a type with a set of properties K of type T
MetricQuery
object
14 properties 7 required
ApiSuccess_ApiExecuteAsyncMetricQueryResults_
object
2 properties 2 required
ChartSourceType.DBT_EXPLORE
string
CreateDashboardDataAppTile
DashboardHeadingTile
PieChartValueLabel
string
DashboardTile
Partial_CompleteCartesianChartLayout_
object
Make all properties in T optional
13 properties
PieChart
object
14 properties
GroupValueRule
object
2 properties 2 required
MapFieldConfig
object
2 properties
ApiGetRolesResponse
object
2 properties 2 required
Pick_CompiledDimension.label-or-name-or-table_
object
From T, pick a set of properties whose keys are in the union K
3 properties 3 required
TableCalculationTemplateType.WINDOW_FUNCTION
string
CatalogField
CartesianChartLayout
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…
ApiSuccessEmpty
object
2 properties 1 required
TimeFrames
string
Record_string.never_
object
Construct a type with a set of properties K of type T
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
SqlTableCalculation
CatalogOwner
object
4 properties 4 required
QueryHistoryStatus.PENDING
string
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FixedNumberBinDimension
object
7 properties 7 required
Pick_UpdatedByUser.userUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property 1 required
ChartType.SANKEY
string
DeletedDashboardContentSummary
object
10 properties 10 required
ApiRoleAssigneesResponse
object
2 properties 2 required
GaugeSection
object
5 properties 3 required
ValidationSourceType
string
PivotValuesColumn
object
5 properties 4 required
Record_string.DashboardParameterValue_
object
Construct a type with a set of properties K of type T
WithDescendantCounts_DeletedDashboardContentSummary.chart-or-scheduler_
MapChartConfig
object
2 properties 1 required
FeatureFlag
object
2 properties 2 required
GroupByColumn
object
1 property 1 required
ParameterDefinitions
ApiContentActionBody_ContentActionMove_
object
2 properties 2 required
Series
object
14 properties 2 required
CustomFormat
object
9 properties 1 required
ChartType.FUNNEL
string
CatalogType.Field
string
TableCalculationTemplate
ChartType.BIG_NUMBER
string
TemplateTableCalculation
DashboardSqlChartTileProperties
object
2 properties 2 required
ConditionalFormattingConfig
AddScopesToRole
object
1 property 1 required
SourcePosition
object
2 properties 2 required
ChartType.GAUGE
string
ValuesColumn
object
2 properties 2 required
TabAuditGroup
object
3 properties 3 required
BigNumberConfig
object
2 properties 1 required
PreAggregateDailyStatResult
object
12 properties 12 required
ApiRemoveScopeFromRoleResponse
TilePreAggregateAuditStatus
VizIndexType
string
ApiSchedulerRunsResponse
ConditionalFormattingConfigWithColorRange
object
4 properties 3 required
LogCounts
object
5 properties 5 required
CreateDashboardHeadingTile
DashboardFilterValidationErrorType
string
PreAggregateMaterializationSummary
object
15 properties 15 required
FunnelChartLegendPosition
string
Required_CreateDashboardTileBase_
object
Make all properties in T required
7 properties 6 required
CustomDimension
DashboardParameterValue
object
2 properties 2 required
ValidationResponseBase
object
9 properties 7 required
ResultsPaginationMetadata_ResultRow_
KnexPaginatedData_SchedulerAndTargets-Array_
object
2 properties 1 required
ApiExecuteAsyncMetricQueryResults
ChartSourceType.SQL
string
ChartType.TABLE
string
MapTileBackground
string
CommonExecuteQueryRequestParams
object
4 properties
FieldType.METRIC
string
SpaceMemberRole
string
ExecuteAsyncFieldValueSearchRequestParams
ApiGetPreAggregateStatsResponse
object
2 properties 2 required
ChartType.PIE
string
ContentType.SPACE
string
ApiSuccess_ApiGetProjectParametersListResults_
object
2 properties 2 required
ValidationErrorDashboardResponse
SpaceContent
object
24 properties 24 required
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
ResultValue
object
2 properties 2 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
CustomGroupBinDimension
object
7 properties 7 required
SankeyNodeLayout
string
How nodes are laid out: - multi-step: depth-unrolled journeys (default) - merged: one node per label, journeys preserved (acyclic flows only) - direct: two-col…
DashboardLoomTileProperties
object
2 properties 2 required
KnexPaginatedData_ApiPreAggregateMaterializationsResults_
object
2 properties 1 required
Pick_CreateDashboard.name-or-description-or-spaceUuid-or-colorPaletteUuid_
object
From T, pick a set of properties whose keys are in the union K
4 properties 1 required
RoleWithScopes
XAxis
ChartType.CUSTOM
string
ChartType.MAP
string
SchedulerRunStatus
string
QueryHistoryStatus.CANCELLED
string
SummaryContent
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
ColorPaletteSource
Where a resolved colour palette came from. The config and default cases carry no entity reference; the rest expose the UUID and human-readable name of the enti…
CartesianChartConfig
object
2 properties 1 required
AppVersionStatus
string
GaugeChart
object
9 properties
Omit_MetricQueryRequest.csvLimit_
Construct a type with the properties of T except for those in type K.
ConditionalFormattingMinMax_number-or-auto_
object
2 properties 2 required
GaugeChartConfig
object
2 properties 1 required
ColumnProperties
object
6 properties
MapChartLocation
string
TableChart
object
12 properties
DashboardPreAggregateAudit
object
5 properties 5 required
DeletedContentItem
Partial_CompleteEChartsConfig_
object
Make all properties in T optional
10 properties
PieChartLegendPosition
string
DimensionType
string
ThresholdOptions
object
3 properties 3 required
CreateDashboardSqlChartTile
UpdatedByUser
object
3 properties 3 required
SchedulerImageOptions
object
1 property
VizAggregationOptions
string
FrameClause
object
3 properties 2 required
ValidationResponse
EchartsLegend
object
12 properties
ContentType
string
Comment
object
10 properties 8 required
FieldType
string
ValidationErrorChartResponse
KnexPaginatedData_ValidationResponse-Array_
object
2 properties 1 required
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties 3 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
SqlChartScheduler
ContentType.CHART
string
MapChartType
string
BaseFilterRule_FilterOperator.number-or-string_
object
3 properties 2 required
MarkLineData
object
9 properties 1 required
Compact
string
PreAggregateMaterializationWarning
TableCalculationTemplateType.RUNNING_TOTAL
string
CalculateTotalKind
string
Kinds of totals derivable from an executed pivot query. Follow-up PRs will widen the union to enable the commented-out variants below.
ThresholdOperator
string
BinType.CUSTOM_GROUP
string
Pick_Field.name-or-label-or-fieldType-or-tableLabel-or-description_
object
From T, pick a set of properties whose keys are in the union K
5 properties 4 required
ApiExecuteAsyncDashboardChartQueryResults
TableCalculationBase
object
5 properties 2 required
TableChartConfig
object
2 properties 1 required
DashboardTileTypes.DATA_APP
string
ApiPreAggregateStatsResults
object
1 property 1 required
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
ComparisonFormatTypes
string
DashboardUnversionedFields
ApiExecuteAsyncDashboardSqlChartQueryResults
UpdateDashboard
Pick_Dimension.requiredAttributes-or-anyAttributes_
object
From T, pick a set of properties whose keys are in the union K
2 properties
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
ApiRestoreContentBody
object
1 property 1 required
QueryHistoryStatus.READY
string
DashboardHeadingTileProperties
object
2 properties 2 required
ApiPermanentlyDeleteContentBody
object
1 property 1 required
KnexPaginateArgs
object
2 properties 2 required
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
CustomFormatType
string
SchedulerOptions
SavedChart
object
28 properties 22 required
DashboardTileTypes.SAVED_CHART
string
ApiSavedChartPaginatedSchedulersResponse
object
2 properties 2 required
WithDescendantCounts_DeletedSpaceContentSummary.nestedSpace-or-dashboard-or-chart-or-scheduler-or-app_
PivotConfig
object
8 properties 2 required
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
Scheduler
ApiGetComments
object
2 properties 2 required
ProjectDefaults
object
Project-wide default settings that can be overridden at explore or field level
1 property
Record_string.AnyType_
object
Construct a type with a set of properties K of type T
CustomSqlDimension
object
6 properties 6 required
AndFilterGroup
object
2 properties 2 required
KnexPaginatedData_DeletedContentWithDescendants-Array_
object
2 properties 1 required
UserAttributeValueMap
CustomDimensionType.SQL
string
DashboardConfig
object
6 properties 1 required
ConditionalFormattingWithFilterOperator
DateZoom
object
2 properties
ApiSuccess_ApiDownloadAsyncQueryResults-or-ApiDownloadAsyncQueryResultsAsCsv-or-ApiDownloadAsyncQueryResultsAsXlsx_
object
2 properties 2 required
ApiExecuteAsyncFieldValueSearchResults
object
2 properties 2 required
ApiExecuteAsyncQueryResultsCommon
object
5 properties 5 required
DateGranularity
string
ReadyQueryResultsPage
TileIneligibleReason
string
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
UpsertUserRoleAssignmentRequest
object
2 properties 1 required
CreateDashboardMarkdownTile
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
ApiSuccess_KnexPaginatedData_SchedulerRun-Array__
object
2 properties 2 required
CustomVis
object
1 property
ResultRow
ItemsMap
ChartContent
object
19 properties 19 required
OrFilterGroup
object
2 properties 2 required
ApiRoleWithScopesResponse
object
2 properties 2 required
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
ApiSuccess_ProjectDefaults-or-undefined_
object
2 properties 1 required
DashboardLoomTile
UpdateRoleAssignmentRequest
object
1 property 1 required
ResultColumn
object
2 properties 2 required
Pick_ValidationResponseBase.Exclude_keyofValidationResponseBase.name__
object
From T, pick a set of properties whose keys are in the union K
8 properties 6 required
DashboardVersionedFields
ExecuteAsyncSavedChartRequestParams
TableCalculationType
string
ContentSortByColumns
string
ApiDashboardResponse
object
2 properties 2 required
ApiJobScheduledResponse
object
2 properties 2 required
DashboardTab
object
4 properties 3 required
SchedulerResourceType
string
RoleAssignee
object
5 properties 5 required
CreateRole
object
3 properties 1 required
WithDescendantCounts_DeletedDataAppContentSummary.never_
ApiSingleValidationResponse
Pick_MetricQueryRequest.Exclude_keyofMetricQueryRequest.csvLimit__
object
From T, pick a set of properties whose keys are in the union K
15 properties 7 required
ExecuteAsyncSqlQueryRequestParams
ExecuteAsyncUnderlyingDataRequestParams
SchedulerFormat
string
SchedulerGsheetsOptions
object
5 properties 4 required
DeletedSqlChartContentSummary
DashboardMarkdownTileProperties
object
2 properties 2 required
MapHexbinAggregation
string
DeletedChartBase
object
11 properties 11 required
AppScheduler
ApiRunDashboardPreAggregateAuditBody
object
1 property
ChartType.CARTESIAN
string
ApiDownloadAsyncQueryResultsAsCsv
object
2 properties 2 required
TilePreAggregateAuditHit
object
7 properties 7 required
ExecuteAsyncDashboardSqlChartCommonParams
DashboardParameters
SchedulerEmailTarget
object
5 properties 5 required
Pick_DownloadAsyncQueryResultsRequestParams.Exclude_keyofDownloadAsyncQueryResultsRequestParams.queryUuid__
object
From T, pick a set of properties whose keys are in the union K
9 properties
Role
object
8 properties 8 required
ApiGetPreAggregateMaterializationsResponse
object
2 properties 2 required
DashboardTileTypes.HEADING
string
FunnelChartDataInput
string
DashboardTileTypes.SQL_CHART
string
ChartKind
string
SeriesMetadata
object
1 property 1 required
MetricType
string
DeletedDataAppContentSummary
object
10 properties 10 required
ApiDeletedContentResponse
object
2 properties 2 required
PivotIndexColum
object
2 properties 2 required
ApiRoleAssignmentListResponse
object
2 properties 2 required
DeletedSpaceContentSummary
object
10 properties 10 required
Axis
object
7 properties
TableCalculation
Record_string.LightdashProjectParameter_
object
Construct a type with a set of properties K of type T
SankeyChart
object
6 properties
FilterRule
object
8 properties 3 required
ExecuteAsyncDashboardSqlChartByUuidRequestParams
ApiSuccess_KnexPaginatedData_ValidationResponse-Array__
object
2 properties 2 required
TilePreAggregateAuditIneligible
object
5 properties 5 required
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
ItemPayload
Field
object
20 properties 8 required
ApiContentBulkActionBody_ContentActionMove_
object
2 properties 2 required
RoleAssignment
object
10 properties 8 required
ApiSuccess_ApiExecuteAsyncFieldValueSearchResults_
object
2 properties 2 required
DashboardScheduler
ConditionalFormattingConfigWithSingleColor
object
5 properties 3 required
ApiPaginatedMetricsWithTimeDimensionResponse
object
2 properties 2 required
Record_string.ColumnProperties_
object
Construct a type with a set of properties K of type T
GroupValueMatchType
string
Dashboard
object
27 properties 21 required
ApiDownloadAsyncQueryResultsAsXlsx
object
2 properties 2 required
ParameterValue
EmojiIcon
object
1 property 1 required
QueryExecutionContext
string
KnexPaginatedData_ApiPreAggregateStatsResults_
object
2 properties 1 required
ParametersValuesMap
WindowFunctionType
string
FunnelChartConfig
object
2 properties 1 required
ValidationErrorTableResponse
ApiSuccess_ApiGetProjectParametersResults_
object
2 properties 2 required
ChartConfig
DashboardChartTile
WithDescendantCounts_DeletedSqlChartContentSummary.never_
ResultColumns
Record_string.string-Array_
object
Construct a type with a set of properties K of type T
ConditionalFormattingWithCompareTarget_number-or-string_
BinType.FIXED_WIDTH
string
ApiSuccess_ApiExecuteAsyncDashboardChartQueryResults_
object
2 properties 2 required
ExecuteAsyncSqlChartBySlugRequestParams
SchedulerAndTargets
ChartSourceType
string
CatalogSortField
string
FilterOperator
string
CustomDimensionType.BIN
string
ExecuteAsyncSqlChartRequestParams
KnexPaginatedData_CatalogField-Array_
object
2 properties 1 required
ApiSuccess_ValidationResponse_
object
2 properties 2 required
Record_string.string_
object
Construct a type with a set of properties K of type T
WithDescendantCounts_DeletedDbtChartContentSummary.scheduler_
ExecuteAsyncDashboardSqlChartBySlugRequestParams
Pick_Tag.name-or-color-or-tagUuid-or-yamlReference_
object
From T, pick a set of properties whose keys are in the union K
4 properties 4 required
ContentType.DATA_APP
string
Format
string
ConditionalFormattingColorApplyTo
string
SchedulerSlackTarget
object
5 properties 5 required
DashboardContent
object
16 properties 16 required
CreateDashboardChartTile
ApiDownloadAsyncQueryResults
object
1 property 1 required
FieldUrl
object
2 properties 2 required
PreAggregateMaterializationRole
object
2 properties 2 required
DashboardTileTarget
CustomIcon
object
1 property 1 required
PivotConfiguration
object
9 properties 1 required
Metric
object
33 properties 8 required
RowLimit
object
3 properties 3 required
Pick_Metric.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
DashboardTileTypes.LOOM
string
TreemapChartConfig
object
2 properties 1 required
ApiSuccess_ApiExecuteAsyncDashboardSqlChartQueryResults_
object
2 properties 2 required
NotificationFrequency
string
FixedWidthBinDimension
object
7 properties 7 required
MapChart
object
26 properties
DataAppContent
object
18 properties 18 required
DimensionOverrides
object
BinType.FIXED_NUMBER
string
ApiGetAsyncQueryResultsResponse
object
2 properties 2 required
KnexPaginatedData_SummaryContent-Array_
object
2 properties 1 required
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
DashboardTileTypes
string
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
SpaceAccess
object
6 properties 3 required
ApiSuccess_undefined_
object
2 properties 1 required
FormulaTableCalculation
DashboardSqlChartTile
LightdashProjectParameter
object
8 properties 1 required
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
FrameType
string
Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_
Construct a type with the properties of T except for those in type K.
FieldId
string
SortByDirection
string
BigNumber
object
11 properties
ApiExecuteAsyncSqlQueryResults
ExecuteAsyncCalculateTotalRequestParams
object
3 properties 1 required
DefaultTimeDimension
object
2 properties 2 required
CreateDashboardLoomTile
SchedulerRun
object
15 properties 15 required
ApiPreAggregateMaterializationsResults
object
1 property 1 required
SchedulerJobStatus
string
FieldTarget
object
1 property 1 required
ApiDashboardPaginatedSchedulersResponse
object
2 properties 2 required
ApiGetProjectParametersResults
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
QueryHistoryStatus.EXPIRED
string
PreAggregateMissReason.USER_BYPASS
string
PreAggregateMatchMiss
DashboardMarkdownTile
CompactOrAlias
CustomVisConfig
object
2 properties 1 required
BinGroup
object
2 properties 2 required
PreAggregateMaterializationStatus
string
ChartScheduler
DashboardTileTypes.MARKDOWN
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
QueryResultsMetadata
object
1 property 1 required
TooltipSortBy
string
QueryHistoryStatus.EXECUTING
string
Record_string.SeriesMetadata_
object
Construct a type with a set of properties K of type T
SortField
object
4 properties 2 required
NumberSeparator
string
CustomBinDimension
SchedulerPdfOptions
ApiSavedChartResponse
object
2 properties 2 required
SankeyChartConfig
object
2 properties 1 required
ApiPaginatedValidateResponse
SchedulerMsTeamsTarget
object
5 properties 5 required
DashboardFilters
object
3 properties 3 required
DashboardTileBase
KnexPaginatedData_SchedulerRun-Array_
object
2 properties 1 required
ApiDefaultRoleResponse
object
2 properties 2 required
XAxisSortType
string
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
SchedulerGoogleChatTarget
object
5 properties 5 required
DashboardDataAppTileProperties
object
2 properties 2 required
ApiUnassignRoleFromUserResponse
ApiGetDashboardPreAggregateAuditResponse
object
2 properties 2 required
Record_string._value-ResultValue__
object
Construct a type with a set of properties K of type T
BinType.CUSTOM_RANGE
string
ContentType.DASHBOARD
string
VizSortBy
object
4 properties 2 required
RoleAssigneeKind
string
Omit_ValidationResponseBase.name_
Construct a type with the properties of T except for those in type K.
CustomRangeBinDimension
object
7 properties 7 required
PivotSortAnchor
object
Coordinates of a single pivot column, used to anchor a row sort to that specific column when results are pivoted.
2 properties 2 required
TableCalculationTemplateType.RANK_IN_COLUMN
string
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
ConditionalFormattingWithValues_number-or-string_
ChartType.TREEMAP
string
ExecuteAsyncMetricQueryRequestParams
DashboardFieldTarget
object
4 properties 2 required
DashboardPreAggregateAuditSummary
object
3 properties 3 required
ConditionalFormattingColorRange
object
2 properties 2 required
PieChartConfig
object
2 properties 1 required
FunnelChart
object
8 properties
ExecuteAsyncSqlChartByUuidRequestParams
EchartsGrid
object
7 properties
ExecuteAsyncDashboardChartRequestParams
CartesianChart
object
6 properties 2 required
PreAggregateMaterializationTrigger
string
ApiRoleAssignmentResponse
object
2 properties 2 required
CreateDashboardTileBase
object
7 properties 5 required
FunnelChartLabelPosition
string
EChartsConfig
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties 3 required
MapHexbinValueBasis
string
ContentVerificationInfo
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-v2-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash AiAgents API
AE Profile APIs.io
Lightdash Bulk action API
AE Profile APIs.io
Lightdash Catalog API
AE Profile APIs.io
Lightdash Changesets API
AE Profile APIs.io
Lightdash Charts API
AE Profile APIs.io
Lightdash Comments API
AE Profile APIs.io
Lightdash Content API
AE Profile APIs.io
Lightdash Custom Roles API
AE Profile APIs.io
Lightdash Dashboards API
AE Profile APIs.io
Lightdash Explorer API
AE Profile APIs.io
Lightdash Exploring API
AE Profile APIs.io
Lightdash Exports API
AE Profile APIs.io
#V2
← Back to L APIs
API Details
ID
lightdash:lightdash-v2-api
Base URL
https://app.lightdash.cloud
Docs
https://docs.lightdash.com/api-reference/v1/introduction
Provider
Lightdash
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightdash-v2-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightdash-v2-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Lightdash v2 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.