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 Schedulers API

The Schedulers API from Lightdash — 12 operation(s) for schedulers.

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

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

Requests are made against a single base URL, /.

14 operations 12 paths 75 schemas 1 DELETE8 GET3 PATCH2 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 Schedulers 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 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 8 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Schedulers 14
GET
/api/v1/schedulers/{projectUuid}/logsdeprecated
Get scheduler logs
getSchedulerLogs 7 params → 200default
GET
/api/v1/schedulers/{projectUuid}/runs
List scheduler runs
getSchedulerRuns 12 params → 200default
GET
/api/v1/schedulers/runs/{runId}/logs
Get run logs
getRunLogs 1 param → 200default
GET
/api/v1/schedulers/user-schedulers
List user schedulers
listUserSchedulers 10 params → 200default
GET
/api/v1/schedulers/{projectUuid}/list
List schedulers
ListSchedulers 12 params → 200default
GET
/api/v1/schedulers/{schedulerUuid}
Get scheduler
getScheduler 1 param → 200default
PATCH
/api/v1/schedulers/{schedulerUuid}
Update scheduler
updateScheduler 1 param body → 201default
DELETE
/api/v1/schedulers/{schedulerUuid}
Delete scheduler
deleteScheduler 1 param → 201default
PATCH
/api/v1/schedulers/{schedulerUuid}/enabled
Update scheduler enabled status
updateSchedulerEnabled 1 param body → 201default
PATCH
/api/v1/schedulers/{projectUuid}/reassign-owner
Reassign scheduler owner
reassignSchedulerOwner 1 param body → 200default
GET
/api/v1/schedulers/{schedulerUuid}/jobsdeprecated
Get scheduled jobs
getScheduledJobs 1 param → 200default
GET
/api/v1/schedulers/job/{jobId}/status
Get scheduler job status
getSchedulerJobStatus 1 param → 200default
POST
/api/v1/schedulers/send
Send scheduler
sendScheduler body → 200default
POST
/api/v1/schedulers/{schedulerUuid}/send
Send scheduler by uuid
sendSchedulerByUuid 1 param → 200default

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are SchedulerBase (26 properties), SchedulerRun (15 properties), SchedulerRunLogsResponse (10 properties), FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_ (8 properties). Each schema is shown below with its type and property counts.

SchedulerResourceType
string
DashboardFilterRule
SchedulerPdfOptions
SchedulerImageOptions
object
1 property
KnexPaginatedData_SchedulerAndTargets-Array_
object
2 properties 1 required
SchedulerWithLogs
object
5 properties 5 required
DashboardTileTarget
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
ApiSuccess_KnexPaginatedData_SchedulerAndTargets-Array__
object
2 properties 2 required
SchedulerRunStatus
string
ApiTestSchedulerResponse
object
2 properties 2 required
SchedulerRunLogsResponse
object
10 properties 10 required
KnexPaginatedData_SchedulerWithLogs_
object
2 properties 1 required
SchedulerFormat
string
SchedulerRun
object
15 properties 15 required
DashboardFieldTarget
object
4 properties 2 required
ApiSuccess_KnexPaginatedData_SchedulerRun-Array__
object
2 properties 2 required
SchedulerGsheetsOptions
object
5 properties 4 required
SchedulerMsTeamsTarget
object
5 properties 5 required
SchedulerJobStatus
string
KnexPaginatedData_SchedulerRun-Array_
object
2 properties 1 required
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…
PartialFailure
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
SchedulerAndTargets
BaseSchedulerLog
object
5 properties 5 required
Record_string.never_
object
Construct a type with a set of properties K of type T
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties 3 required
FilterOperator
string
AppScheduler
SchedulerGoogleChatTarget
object
5 properties 5 required
ApiScheduledJobsResponse
object
2 properties 2 required
SchedulerBase
object
26 properties 19 required
KnexPaginateArgs
object
2 properties 2 required
NotificationFrequency
string
PartialFailureType.MISSING_TARGETS
string
SchedulerDetails
object
5 properties
SchedulerOptions
ApiJobStatusResponse
object
2 properties 2 required
SqlChartScheduler
ApiSchedulersResponse
DashboardScheduler
SchedulerTaskName
string
SchedulerTargetType
string
SchedulerEmailTarget
object
5 properties 5 required
MissingTargetsPartialFailure
object
1 property 1 required
ApiSchedulerRunLogsResponse
ApiReassignSchedulerOwnerResponse
ApiSuccess_SchedulerRunLogsResponse_
object
2 properties 2 required
ApiSchedulerRunsResponse
Scheduler
DashboardChartPartialFailure
object
5 properties 5 required
LogCounts
object
5 properties 5 required
Record_string.AnyType_
object
Construct a type with a set of properties K of type T
PartialFailureType.DASHBOARD_SQL_CHART
string
DashboardSqlChartPartialFailure
object
5 properties 5 required
ParameterValue
ApiSchedulerLogsResponse
ReassignSchedulerOwnerRequest
object
2 properties 2 required
ApiSuccess_KnexPaginatedData_SchedulerWithLogs__
object
2 properties 2 required
SchedulerLog
ChartScheduler
ThresholdOperator
string
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
DimensionType
string
ThresholdOptions
object
3 properties 3 required
SchedulerRunLog
PartialFailureType.DASHBOARD_CHART
string
ApiSchedulerAndTargetsResponse
object
2 properties 2 required
ApiSuccess_SchedulerAndTargets-Array_
object
2 properties 2 required
SchedulerCsvOptions
object
4 properties 2 required
ScheduledJobs
object
2 properties 2 required
SchedulerSlackTarget
object
5 properties 5 required
ParametersValuesMap
ThresholdStatus
string
Outcome of evaluating a threshold-alert scheduler against the latest query results. Emitted on SchedulerDetails.thresholdStatus and on the schedulerjob.complet…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-schedulers-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 Schedulers 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.