Lightdash Analytics project API

openapi: 3.2.0
info:
  title: Lightdash Analytics project API
  version: 2.616.2
  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: Analytics project
paths:
  /api/v1/org/analytics-project:
    get:
      operationId: GetAnalyticsProjectStatus
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccess_AnalyticsProjectStatus_'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Get internal analytics project status
      tags:
      - Analytics project
      security: []
      parameters: []
    post:
      operationId: EnsureAnalyticsProject
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccess_EnsureAnalyticsProjectResult_'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Ensure internal analytics project
      tags:
      - Analytics project
      security: []
      parameters: []
  /api/v1/org/analytics-project/sample-content:
    post:
      operationId: InstallAnalyticsSampleContent
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Install sample charts and dashboard in the internal analytics project
      tags:
      - Analytics project
      security: []
      parameters: []
  /api/v1/org/analytics-project/{projectUuid}:
    delete:
      operationId: DeleteAnalyticsProject
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      summary: Delete the organization's internal analytics project
      tags:
      - Analytics project
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
components:
  schemas:
    ApiSuccess_EnsureAnalyticsProjectResult_:
      properties:
        results:
          $ref: '#/components/schemas/EnsureAnalyticsProjectResult'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    AnyType:
      description: '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 only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    ApiSuccess_AnalyticsProjectStatus_:
      properties:
        results:
          $ref: '#/components/schemas/AnalyticsProjectStatus'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    UUID:
      type: string
      format: uuid
      description: 'Stringified UUIDv4.

        See [RFC 4112](https://tools.ietf.org/html/rfc4122)'
      pattern: '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}'
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
      required:
      - status
      type: object
    EnsureAnalyticsProjectResult:
      properties:
        created:
          type: boolean
        url:
          type: string
        projectUuid:
          type: string
      required:
      - created
      - url
      - projectUuid
      type: object
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
    AnalyticsProjectStatus:
      properties:
        project:
          properties:
            hasContentUpdates:
              type: boolean
              description: Count-based check only; does not detect edits to existing definitions.
            createdAt:
              type: string
            url:
              type: string
            slug:
              type:
              - string
              - 'null'
            name:
              type: string
            projectUuid:
              type: string
          required:
          - hasContentUpdates
          - createdAt
          - url
          - slug
          - name
          - projectUuid
          type:
          - object
          - 'null'
      required:
      - project
      type: object
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'
x-provenance:
  method: harvested
  publisher: Lightdash
  source: https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)