Lightdash SQL runner API

The SQL runner API from Lightdash — 18 operation(s) for sql runner.

Operations 22

GET /api/v1/projects/{projectUuid}/sqlRunner/tables List warehouse tables #
GET /api/v1/projects/{projectUuid}/sqlRunner/fields Get table fields #
POST /api/v1/projects/{projectUuid}/sqlRunner/run Run SQL query #
POST /api/v1/projects/{projectUuid}/sqlRunner/runPivotQuery Run SQL pivot query #
GET /api/v1/projects/{projectUuid}/sqlRunner/results/{fileId} Get stored results #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid} Get SQL chart #
PATCH /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid} Update SQL chart #
DELETE /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid} Delete SQL chart #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug} Get SQL chart by slug #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}/results-job Get SQL chart results job #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/results-job Get SQL chart results job by UUID #
POST /api/v1/projects/{projectUuid}/sqlRunner/saved Create SQL chart #
POST /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promote Promote SQL chart #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promoteDiff Get SQL chart promotion diff #
POST /api/v1/projects/{projectUuid}/sqlRunner/refresh-catalog Refresh catalog cache #
POST /api/v1/projects/{projectUuid}/sqlRunner/virtual-view Create virtual view #
PUT /api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name} Update virtual view #
DELETE /api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name} Delete virtual view #
POST /api/v1/projects/{projectUuid}/sqlRunner/preview Preview write back #
POST /api/v1/projects/{projectUuid}/sqlRunner/pull-request Create write back PR #
GET /api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers List SQL chart schedulers #
POST /api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers Create SQL chart scheduler #

Documentation

Specifications

Schemas & Data

Other Resources

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-sql-runner-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.

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

OpenAPI Specification

lightdash-sql-runner-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Lightdash AiAgents SQL runner 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:
- name: SQL runner
paths:
  /api/v1/projects/{projectUuid}/sqlRunner/tables:
    get:
      operationId: getTables
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiWarehouseTablesCatalog'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get warehouse tables for a project
      summary: List warehouse tables
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/fields:
    get:
      operationId: getTableFields
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiWarehouseTableFields'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get fields for a warehouse table
      summary: Get table fields
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: query
        name: tableName
        required: false
        schema:
          type: string
      - in: query
        name: schemaName
        required: false
        schema:
          type: string
      - in: query
        name: databaseName
        required: false
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/run:
    post:
      operationId: runSql
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiJobScheduledResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Run a SQL query
      summary: Run SQL query
      tags:
      - SQL runner
      deprecated: true
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SqlRunnerBody'
  /api/v1/projects/{projectUuid}/sqlRunner/runPivotQuery:
    post:
      operationId: runSqlPivotQuery
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiJobScheduledResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Run a SQL pivot query
      summary: Run SQL pivot query
      tags:
      - SQL runner
      deprecated: true
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SqlRunnerPivotQueryBody'
  /api/v1/projects/{projectUuid}/sqlRunner/results/{fileId}:
    get:
      operationId: getLocalResults
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyType'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get results from a file stored locally
      summary: Get stored results
      tags:
      - SQL runner
      deprecated: true
      security: []
      parameters:
      - description: the fileId for the file
        in: path
        name: fileId
        required: true
        schema:
          type: string
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}:
    get:
      operationId: getSavedSqlChart
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSqlChart'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get saved sql chart
      summary: Get SQL chart
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the saved sql chart
        in: path
        name: uuid
        required: true
        schema:
          type: string
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
    patch:
      operationId: updateSqlChart
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpdateSqlChart'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update sql chart
      summary: Update SQL chart
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - description: the uuid for the saved sql chart
        in: path
        name: uuid
        required: true
        schema:
          type: string
      requestBody:
        description: the sql chart details to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSqlChart'
              description: the sql chart details to update
    delete:
      operationId: deleteSqlChart
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete sql chart
      summary: Delete SQL chart
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - description: the uuid for the saved sql chart
        in: path
        name: uuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}:
    get:
      operationId: getSavedSqlChartBySlug
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSqlChart'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get saved sql chart
      summary: Get SQL chart by slug
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the slug for the saved sql chart
        in: path
        name: slug
        required: true
        schema:
          type: string
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved/slug/{slug}/results-job:
    get:
      operationId: getSavedSqlResultsJob
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiJobScheduledResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Schedules a job to get its results
      summary: Get SQL chart results job
      tags:
      - SQL runner
      deprecated: true
      security: []
      parameters:
      - description: '- the slug of the saved chart'
        in: path
        name: slug
        required: true
        schema:
          type: string
      - description: '- the uuid of the project'
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/results-job:
    get:
      operationId: getSavedSqlResultsJobByUuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiJobScheduledResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Schedules a job to get its results
      summary: Get SQL chart results job by UUID
      tags:
      - SQL runner
      deprecated: true
      security: []
      parameters:
      - description: '- the uuid of the saved chart'
        in: path
        name: uuid
        required: true
        schema:
          type: string
      - description: '- the uuid of the project'
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved:
    post:
      operationId: createSqlChart
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateSqlChart'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create sql chart
      summary: Create SQL chart
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        description: the sql chart to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSqlChart'
              description: the sql chart to create
  /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promote:
    post:
      operationId: promoteSqlChart
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSqlChart'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Promote SQL chart to upstream project
      summary: Promote SQL chart
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - description: the uuid for the saved sql chart
        in: path
        name: uuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/saved/{uuid}/promoteDiff:
    get:
      operationId: promoteSqlChartDiff
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPromotionChangesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get diff from SQL chart to promote
      summary: Get SQL chart promotion diff
      tags:
      - SQL runner
      security: []
      parameters:
      - description: the uuid for the project
        in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - description: the uuid for the saved sql chart
        in: path
        name: uuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/refresh-catalog:
    post:
      operationId: refreshSqlRunnerCatalog
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Refresh the catalog cache
      summary: Refresh catalog cache
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/virtual-view:
    post:
      operationId: createVirtualView
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateVirtualView'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create a virtual-view
      summary: Create virtual view
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualViewPayload'
  /api/v1/projects/{projectUuid}/sqlRunner/virtual-view/{name}:
    put:
      operationId: updateVirtualView
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCreateVirtualView'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update a virtual view
      summary: Update virtual view
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVirtualViewPayload'
    delete:
      operationId: deleteVirtualView
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete a virtual-view
      summary: Delete virtual view
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: name
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/sqlRunner/preview:
    post:
      operationId: writeBackPreview
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGithubDbtWritePreview'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Preview write back from SQL runner
      summary: Preview write back
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualViewPayload'
  /api/v1/projects/{projectUuid}/sqlRunner/pull-request:
    post:
      operationId: writeBackCreatePr
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGithubDbtWriteBack'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Write back from SQL runner
      summary: Create write back PR
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualViewPayload'
  /api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers:
    get:
      operationId: getSqlChartSchedulers
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                properties:
                  results:
                    items:
                      $ref: '#/components/schemas/SchedulerAndTargets'
                    type: array
                  status:
                    type: string
                    enum:
                    - ok
                required:
                - results
                - status
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get all schedulers for a SQL chart
      summary: List SQL chart schedulers
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: savedSqlUuid
        required: true
        schema:
          type: string
    post:
      operationId: createSqlChartScheduler
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                properties:
                  results:
                    $ref: '#/components/schemas/SchedulerAndTargets'
                  status:
                    type: string
                    enum:
                    - ok
                required:
                - results
                - status
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create a scheduler for a SQL chart
      summary: Create SQL chart scheduler
      tags:
      - SQL runner
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: savedSqlUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSchedulerAndTargetsWithoutIds'
components:
  schemas:
    ? Pick_Space.organizationUuid-or-projectUuid-or-uuid-or-name-or-inheritParentPermissions-or-projectMemberAccessRole-or-pinnedListUuid-or-pinnedListOrder-or-slug-or-parentSpaceUuid-or-path_
    : properties:
        name:
          type: string
        projectUuid:
          type: string
        organizationUuid:
          type: string
        uuid:
          type: string
        inheritParentPermissions:
          type: boolean
        projectMemberAccessRole:
          allOf:
          - $ref: '#/components/schemas/SpaceMemberRole'
        pinnedListUuid:
          type:
          - string
          - 'null'
        pinnedListOrder:
          type:
          - number
          - 'null'
          format: double
        slug:
          type: string
        parentSpaceUuid:
          type:
          - string
          - 'null'
        path:
          type: string
      required:
      - name
      - projectUuid
      - organizationUuid
      - uuid
      - inheritParentPermissions
      - projectMemberAccessRole
      - pinnedListUuid
      - pinnedListOrder
      - slug
      - parentSpaceUuid
      - path
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Record_string.unknown_:
      properties: {}
      additionalProperties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    PromotionAction:
      enum:
      - no changes
      - create
      - update
      - delete
      type: string
    BinType.CUSTOM_GROUP:
      enum:
      - custom_group
      type: string
    MetricOverrides:
      properties: {}
      additionalProperties:
        $ref: '#/components/schemas/Pick_Metric.formatOptions_'
      type: object
    ChartType.FUNNEL:
      enum:
      - funnel
      type: string
    GroupValueRule:
      properties:
        value:
          type: string
        matchType:
          $ref: '#/components/schemas/GroupValueMatchType'
      required:
      - value
      - matchType
      type: object
    Record_string.AnyType_:
      properties: {}
      additionalProperties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    MapTileBackground:
      enum:
      - none
      - openstreetmap
      - light
      - dark
      - satellite
      - voyager
      type: string
    TimeFrames:
      enum:
      - RAW
      - YEAR
      - QUARTER
      - MONTH
      - WEEK
      - DAY
      - HOUR
      - MINUTE
      - SECOND
      - MILLISECOND
      - DAY_OF_WEEK_INDEX
      - DAY_OF_MONTH_NUM
      - DAY_OF_YEAR_NUM
      - WEEK_NUM
      - MONTH_NUM
      - QUARTER_NUM
      - YEAR_NUM
      - DAY_OF_WEEK_NAME
      - MONTH_NAME
      - QUARTER_NAME
      - HOUR_OF_DAY_NUM
      - MINUTE_OF_HOUR_NUM
      type: string
    VizPieChartDisplay:
      properties:
        isDonut:
          type: boolean
      type: object
    CompactOrAlias:
      anyOf:
      - $ref: '#/components/schemas/Compact'
      - type: string
        enum:
        - K
        - thousand
        - M
        - million
        - B
        - billion
        - T
        - trillion
        - KB
        - kilobyte
        - MB
        - megabyte
        - GB
        - gigabyte
        - TB
        - terabyte
        - PB
        - petabyte
        - KiB
        - kibibyte
        - MiB
        - mebibyte
        - GiB
        - gibibyte
        - TiB
        - tebibyte
        - PiB
        - pebibyte
    MetricFilterRule:
      description: Filter rule for metrics, targeting fields by reference
      properties:
        values:
          items:
            $ref: '#/components/schemas/AnyType'
          type: array
          description: Values to filter by
        operator:
          $ref: '#/components/schemas/FilterOperator'
          description: Filter operator
        id:
          type: string
          description: Unique identifier for the filter
        target:
          properties:
            fieldRef:
              type: string
              description: Field reference to filter on (e.g., 'table_name.field_name')
          required:
          - fieldRef
          type: object
          description: Target field for the filter
        settings:
          $ref: '#/components/schemas/AnyType'
          description: Additional settings for date/time filters
        disabled:
          type: boolean
          description: Whether this filter is disabled
        required:
          type: boolean
          description: Whether this filter is required
        caseSensitive:
          type: boolean
          description: 'Overrides the field/explore case-sensitivity for this rule only.

            Used by internal features like autocomplete search that must always

            match case-insensitively regardless of the field''s configured setting.'
      required:
      - operator
      - id
      - target
      type: object
      additionalProperties: true
    DashboardTileTypes.LOOM:
      enum:
      - loom
      type: string
    ApiCreateSqlChart:
      properties:
        results:
          properties:
            slug:
              type: string
            savedSqlUuid:
              type: string
          required:
          - slug
          - savedSqlUuid
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ChartType.TREEMAP:
      enum:
      - treemap
      type: string
    ParametersValuesMap:
      $ref: '#/components/schemas/Record_string.ParameterValue_'
    ChartType.BIG_NUMBER:
      enum:
      - big_number
      type: string
    ParameterValue:
      anyOf:
      - type: string
      - type: number
        format: double
      - items:
          type: string
        type: array
      - items:
          type: number
          format: double
        type: array
    DashboardMarkdownTileProperties:
      properties:
        properties:
          properties:
            hideFrame:
              type: boolean
            content:
              type: string
            title:
              type: string
          required:
          - content
          - title
          type: object
        type:
          $ref: '#/components/schemas/DashboardTileTypes.MARKDOWN'
      required:
      - properties
      - type
      type: object
    VizCartesianChartConfig:
      allOf:
      - $ref: '#/components/schemas/VizBaseConfig'
      - properties:
          display:
            $ref: '#/components/schemas/CartesianChartDisplay'
          fieldConfig:
            $ref: '#/components/schemas/PivotChartLayout'
          type:
            anyOf:
            - $ref: '#/components/schemas/ChartKind.VERTICAL_BAR'
            - $ref: '#/components/schemas/ChartKind.LINE'
        required:
        - type
        type: object
    FieldTarget:
      properties:
        fieldId:
          type: string
          description: Field ID to filter on
      required:
      - fieldId
      type: object
    TableCalculationType:
      enum:
      - number
      - string
      - date
      - timestamp
      - boolean
      type: string
    ? Pick_CreateSchedulerAndTargets.Exclude_keyofCreateSchedulerAndTargets.savedChartUuid-or-dashboardUuid-or-savedSqlUuid-or-createdBy__
    : properties:
        name:
          type: string
        cron:
          type: string
        projectUuid:
          type:
          - string
          - 'null'
        enabled:
          type: boolean
        timezone:
          type: string
        message:
          type: string
        format:
          $ref: '#/components/schemas/SchedulerFormat'
        projectSchedulerTimezone:
          type: string
        appUuid:
          type:
          - string
          - 'null'
        appName:
          type:
          - string
          - 'null'
        options:
          $ref: '#/components/schemas/SchedulerOptions'
        thresholds:
          items:
            $ref: '#/components/schemas/ThresholdOptions'
          type: array
        notificationFrequency:
          $ref: '#/components/schemas/NotificationFrequency'
        includeLinks:
          type: boolean
        projectName:
          type:
          - string
          - 'null'
        targets:
          items:
            $ref: '#/components/schemas/CreateSchedulerTarget'
          type: array
      required:
      - name
      - cron
      - enabled
      - format
      - appUuid
      - appName
      - options
      - includeLinks
      - targets
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    FrameBoundary:
      properties:
        offset:
          type: number
          format: double
          description: Offset for PRECEDING/FOLLOWING
        type:
          $ref: '#/components/schemas/FrameBoundaryType'
          description: Boundary type
      required:
      - type
      type: object
    Omit_SavedChart.inheritsFromOrgOrProject-or-access_:
      $ref: '#/components/schemas/Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__'
      description: Construct a type with the properties of T except for those in type K.
    Partial_PieChartValueOptions_:
      properties:
        valueLabel:
          type: string
          enum:
          - hidden
          - inside
          - outside
        showValue:
          type: boolean
        showPercentage:
          type: boolean
      type: object
      description: Make all properties in T optional
    ApiGithubDbtWritePreview:
      properties:
        results:
          properties:
            owner:
              type: string
            files:
              items:
                type: string
              type: array
            path:
              type: string
            repo:
              type: string
            url:
              type: string
          required:
          - owner
          - files
          - path
          - repo
          - url
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    FieldId:
      type: string
    DashboardTileTypes.DATA_APP:
      enum:
      - data_app
      type: string
    ApiWarehouseTablesCatalog:
      properties:
        results:
          $ref: '#/components/schemas/WarehouseTablesCatalog'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    Pick_Dashboard.uuid-or-name_:
      properties:
        name:
          type: string
        uuid:
          type: string
      required:
      - name
      - uuid
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    LegendPlacement:
      type: string
      enum:
      - custom
      - outsideRight
      - outsideLeft
      description: 'High-level legend placement preset. Set to ''outsideRight'' or ''outsideLeft'' to

        render the legend beside the pl

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