Lightdash

https://docs.lightdash.com/
Admin
Lightdash instantly turns your dbt project into a full-stack BI platform, enabling analysts to write...
Tokens:1,751,916
Snippets:10,169
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api/v1/slack/install

Source: https://docs.lightdash.com/api-reference/integrations/install-slack

Initiates the Slack installation flow for the user.

```APIDOC
## GET /api/v1/slack/install

### Description
Start the Slack installation flow.

### Method
GET

### Endpoint
/api/v1/slack/install

### Response
#### Success Response (200)
- **status** (string) - Success status

#### Error Response (default)
- **error** (object) - Error details including message, name, and statusCode.
```

--------------------------------

### Example prompts for AI agents

Source: https://docs.lightdash.com/workflow/install-agent-skills

Use these example prompts to leverage installed skills for generating Lightdash configurations and managing content.

```text
Create a revenue metric that sums the amount field from the orders table
```

```text
Add a customer_segment dimension based on the lifetime_value field
```

```text
Generate the Lightdash YAML configuration for my users dbt model
```

```text
Download our organization content, update the acme-brand data app theme with
the new logo and typography rules, upload it safely, and verify the CLI round trip
```

--------------------------------

### Preview a data app locally with lightdash apps preview

Source: https://docs.lightdash.com/data-apps/download-data-apps-as-code

Navigate to the app directory, install dependencies, and start the preview server. The CLI proxy handles authentication securely.

```bash
cd lightdash/apps/revenue-explorer
npm install            # preview does not auto-install
lightdash apps preview
```

--------------------------------

### Example login command

Source: https://docs.lightdash.com/workflow/cli/authenticate

An example of the login command using the subdomain 'petey'.

```bash
lightdash login petey
```

--------------------------------

### Install to PATH

Source: https://docs.lightdash.com/workflow/cli/install

Move the executable to a directory in your PATH and verify the installation by checking the version.

```bash
sudo mv lightdash-macos-<arch> /usr/local/bin/lightdash
lightdash --version
```

--------------------------------

### OpenAPI Slack Installation Endpoint

Source: https://docs.lightdash.com/api-reference/integrations/install-slack

The OpenAPI definition for the GET /api/v1/slack/install endpoint used to start the Slack installation flow.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/slack/install:
    get:
      tags:
        - Integrations
      summary: Install Slack
      description: Start the Slack installation flow
      operationId: installSlack
      parameters: []
      responses:
        '200':
          description: Success
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    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
          nullable: false
      required:
        - error
        - status
      type: object
      description: |-
        The Error object is returned from the api any time there is an error.
        The message contains
    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.
```

--------------------------------

### Complete SDK workflow example

Source: https://docs.lightdash.com/sdk/python-sdk

A full example demonstrating client initialization, model retrieval, query building with metrics and filters, and execution with error handling.

```python
from lightdash import Client, QueryError, QueryTimeout

# Initialize client
client = Client(
    instance_url="https://app.lightdash.cloud",
    access_token="your-api-token",
    project_uuid="your-project-uuid",
)

# Get a model
model = client.get_model("orders")

# Build a query with filters
query = (
    model.query()
    .metrics(model.metrics.total_revenue, model.metrics.order_count)
    .dimensions(model.dimensions.country, model.dimensions.order_date)
    .filter(
        (model.dimensions.status == "completed") &
        (model.dimensions.order_date >= "2024-01-01")
    )
    .sort(model.metrics.total_revenue.desc())
    .limit(50)
)

try:
    result = query.execute()
    df = result.to_df()
    print(f"Fetched {len(result)} rows")
    print(df.head())
except QueryTimeout:
    print("Query took too long - try adding more filters")
except QueryError as e:
    print(f"Query failed: {e.message}")
```

--------------------------------

### OpenAPI Specification for Install GitHub App

Source: https://docs.lightdash.com/api-reference/install-github-app

The OpenAPI definition for the GET /api/v1/github/install endpoint, which redirects to the GitHub App installation flow.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/github/install:
    get:
      summary: Install GitHub App
      description: Install the Lightdash GitHub App and link to an organization
      operationId: installGithubAppForOrganization
      parameters: []
      responses:
        '302':
          description: Not found
      security: []
```

--------------------------------

### Run Database Setup Script

Source: https://docs.lightdash.com/get-started/quickstart/connect-project

Execute the setup script for your operating system to connect the database.

```bash
# macOS / Linux
bash setup.sh

# Windows (PowerShell)
powershell -ExecutionPolicy Bypass -File ./setup.ps1
```

--------------------------------

### lightdash apps create examples

Source: https://docs.lightdash.com/workflow/cli/reference

Scaffold a new app using the default slug or provide a custom slug and description.

```bash
lightdash apps create "Revenue explorer"
```

```bash
lightdash apps create "Revenue explorer" --slug revenue-v2 --description "New pricing model exploration"
```

--------------------------------

### Example: Weekly grain convention override

Source: https://docs.lightdash.com/semantic-layer/lightdash-config-yml

A specific example demonstrating how to set the weekly grain label to 'Week starting Monday'.

```yaml
# lightdash.config.yml
defaults:
  granularity_labels:
    week: "Week starting Monday"
```

--------------------------------

### GET /api/v1/slack

Source: https://docs.lightdash.com/api-reference/integrations/get-slack-installation

Retrieves the Slack installation details for the organization.

```APIDOC
## GET /api/v1/slack

### Description
Get Slack installation details for the organization.

### Method
GET

### Endpoint
/api/v1/slack

### Response
#### Success Response (200)
- **status** (string) - The status of the request, which will be 'ok'.
- **results** (SlackSettings) - The Slack settings object containing configuration details.

#### Error Response (default)
- **status** (string) - The status of the request, which will be 'error'.
- **error** (object) - Contains the error details including 'message', 'name', and 'statusCode'.
```

--------------------------------

### OpenAPI definition for Get resource type

Source: https://docs.lightdash.com/api-reference/scim/get-resource-type

The OpenAPI specification for the GET /api/v1/scim/v2/ResourceTypes/{resourceTypeId} endpoint, including the schema definition and an example response.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/scim/v2/ResourceTypes/{resourceTypeId}:
    get:
      tags:
        - SCIM
      summary: Get resource type
      description: Get individual SCIM resource type
      operationId: GetScimResourceType
      parameters:
        - description: resource type identifier
          in: path
          name: resourceTypeId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimResourceType'
              examples:
                Example 1:
                  value:
                    schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                    id: User
                    name: User
                    description: User Account
                    endpoint: /Users
                    schema: urn:ietf:params:scim:schemas:core:2.0:User
                    schemaExtensions:
                      - schema: urn:lightdash:params:scim:schemas:extension:2.0:User
                        required: false
                    meta:
                      resourceType: ResourceType
                      location: >-
                        https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/User
      security: []
components:
  schemas:
    ScimResourceType:
      properties:
        schemas:
          items:
            $ref: '#/components/schemas/ScimSchemaType.RESOURCE_TYPE'
          type: array
        id:
          type: string
        meta:
          properties:
            version:
              type: string
            location:
              type: string
            lastModified:
              type: string
              format: date-time
            created:
              type: string
              format: date-time
            resourceType:
              type: string
          type: object
        name:
          type: string
        description:
          type: string
        endpoint:
          type: string
        schema:
          type: string
        schemaExtensions:
          items:
            properties:
              required:
                type: boolean
              schema:
                type: string
            required:
              - required
              - schema
            type: object
          type: array
      required:
        - schemas
        - id
        - name
        - endpoint
        - schema
      type: object
      additionalProperties: true
    ScimSchemaType.RESOURCE_TYPE:
      enum:
        - urn:ietf:params:scim:schemas:core:2.0:ResourceType
      type: string
```

--------------------------------

### OpenAPI SCIM Get role definition

Source: https://docs.lightdash.com/api-reference/scim/get-role

The OpenAPI specification for the GET /api/v1/scim/v2/Roles/{roleId} endpoint, including the response schema and an example of a successful role retrieval.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/scim/v2/Roles/{roleId}:
    get:
      tags:
        - SCIM
      summary: Get role
      description: Get a SCIM role by ID
      operationId: GetScimRole
      parameters:
        - description: Role ID - this is used as a unique identifier for SCIM
          in: path
          name: roleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimRole'
              examples:
                Example 1:
                  value:
                    schemas:
                      - urn:ietf:params:scim:schemas:extension:2.0:Role
                    id: member
                    value: member
                    display: Member
                    type: Organization
                    supported: true
                    meta:
                      resourceType: Role
                      location: >-
                        https://<tenant>.lightdash.cloud/api/v1/scim/v2/Roles/member
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimErrorPayload'
      security: []
components:
  schemas:
    ScimRole:
      properties:
        schemas:
          items:
            $ref: '#/components/schemas/ScimSchemaType.ROLE'
          type: array
        id:
          type: string
        meta:
          allOf:
            - properties:
                version:
                  type: string
                location:
                  type: string
                lastModified:
                  type: string
                  format: date-time
                created:
                  type: string
                  format: date-time
                resourceType:
                  type: string
              type: object
            - properties:
                location:
                  type: string
                lastModified:
                  type: string
                  format: date-time
                created:
                  type: string
                  format: date-time
                resourceType:
                  type: string
                  enum:
                    - Role
                  nullable: false
              required:
                - location
                - resourceType
              type: object
        value:
          type: string
        display:
          type: string
        type:
          type: string
        supported:
          type: boolean
      required:
        - schemas
```

--------------------------------

### Example user metadata configuration

Source: https://docs.lightdash.com/embed/reference

A sample object showing how to provide an external ID and email for usage analytics.

```javascript
{
  user: {
    externalId: 'user-12345',
    email: 'jane@example.com',
  }
}
```

--------------------------------

### Preview app from folder

Source: https://docs.lightdash.com/workflow/cli/reference

Steps to preview an app from within its directory.

```bash
cd lightdash/apps/revenue-explorer
npm install
lightdash apps preview
```

--------------------------------

### GET /api/v1/github/install

Source: https://docs.lightdash.com/api-reference/install-github-app

Initiates the installation process for the Lightdash GitHub App, linking it to an organization.

```APIDOC
## GET /api/v1/github/install

### Description
Install the Lightdash GitHub App and link to an organization.

### Method
GET

### Endpoint
/api/v1/github/install

### Response
#### Success Response (302)
- **description** (string) - Not found
```

--------------------------------

### OpenAPI Specification for Get SCIM User

Source: https://docs.lightdash.com/api-reference/scim/get-user

This YAML snippet defines the OpenAPI structure for the GET /api/v1/scim/v2/Users/{userUuid} endpoint, including the expected response format and example user data.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/scim/v2/Users/{userUuid}:
    get:
      tags:
        - SCIM
      summary: Get user
      description: Get a SCIM user by ID
      operationId: GetScimUser
      parameters:
        - description: Lightdash user UUID - this is used as a unique identifier for SCIM
          in: path
          name: userUuid
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
              examples:
                Example 1:
                  value:
                    schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: e0dd2003-c291-4e14-b977-7a03b7edc842
                    userName: demo3@lightdash.com
                    name:
                      givenName: Viewer
                      familyName: User
                    active: true
                    emails:
                      - value: demo3@lightdash.com
                        primary: true
                    roles:
                      - value: viewer
                        display: Viewer
                        type: Organization
                        primary: true
                      - value: 3675b69e-8324-4110-bdca-059031aa8da3:editor
                        display: Jaffle shop - Editor
                        type: Project - Jaffle shop
                        primary: false
                    meta:
                      resourceType: User
                      created: '2025-11-03T14:22:18.464Z'
                      lastModified: '2025-11-05T15:04:02.687Z'
                      location: >-
                        https://<tenant>.lightdash.cloud/api/v1/scim/v2/Users/e0dd2003-c291-4e14-b977-7a03b7edc842
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimErrorPayload'
      security: []
components:
  schemas:
    ScimUser:
      properties:
        schemas:
          items:
            type: string
          type: array
        id:
          type: string
        meta:
          properties:
            version:
              type: string
            location:
              type: string
            lastModified:
              type: string
              format: date-time
            created:
              type: string
              format: date-time
            resourceType:
              type: string
          type: object
        userName:
          type: string
        name:
```

--------------------------------

### Example userAttributes configuration

Source: https://docs.lightdash.com/embed/reference

A sample object showing how to provide tenant, region, and department attributes.

```javascript
{
  userAttributes: {
    tenant_id: 'customer-123',
    region: 'us-west',
    department: 'sales',
  }
}
```

--------------------------------

### POST /api/v1/ee/projects/{projectUuid}/agent-onboarding

Source: https://docs.lightdash.com/api-reference/start-agent-onboarding-run

Starts a server-side agent onboarding run for a prepared project. Returns the existing run if one is already active.

```APIDOC
## POST /api/v1/ee/projects/{projectUuid}/agent-onboarding

### Description
Start a server-side agent onboarding run for a prepared project. Returns the existing run when one is already active for the project.

### Method
POST

### Endpoint
/api/v1/ee/projects/{projectUuid}/agent-onboarding

### Parameters
#### Path Parameters
- **projectUuid** (string) - Required - Stringified UUIDv4 of the project.

### Response
#### Success Response (202)
- **status** (string) - The status of the response (ok).
- **results** (object) - The agent onboarding run details.
```

--------------------------------

### GET /api/v1/github/oauth/callback

Source: https://docs.lightdash.com/api-reference/github-oauth-callback

Callback URL for GitHub App Authorization also used for GitHub App Installation with combined Authorization.

```APIDOC
## GET /api/v1/github/oauth/callback

### Description
Callback URL for GitHub App Authorization also used for GitHub App Installation with combined Authorization.

### Method
GET

### Endpoint
/api/v1/github/oauth/callback

### Parameters
#### Query Parameters
- **code** (string) - Optional - authorization code from GitHub
- **state** (string) - Optional - oauth state parameter
- **installation_id** (string) - Optional - installation id from GitHub
- **setup_action** (string) - Optional - setup action from GitHub

### Response
#### Success Response (204)
- No content
```

--------------------------------

### OpenAPI Specification for Get Slack installation

Source: https://docs.lightdash.com/api-reference/integrations/get-slack-installation

The OpenAPI definition for the /api/v1/slack endpoint, including request parameters, response schemas, and error handling.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/slack:
    get:
      tags:
        - Integrations
      summary: Get Slack installation
      description: Get Slack installation details for the organization
      operationId: getSlackInstallation
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSlackGetInstallationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    ApiSlackGetInstallationResponse:
      $ref: '#/components/schemas/ApiSuccess_SlackSettings-or-undefined_'
    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
          nullable: false
      required:
        - error
        - status
      type: object
      description: |-
        The Error object is returned from the api any time there is an error.
        The message contains
    ApiSuccess_SlackSettings-or-undefined_:
      properties:
        results:
          $ref: '#/components/schemas/SlackSettings'
        status:
          type: string
          enum:
            - ok
          nullable: false
      required:
        - 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.
    SlackSettings:
      properties:
        aiAgentsEnabled:
          type: boolean
        unfurlsEnabled:
          type: boolean
        aiMultiAgentProjectUuids:
          items:
            type: string
          type: array
          nullable: true
```

--------------------------------

### POST /api/v1/jira/install

Source: https://docs.lightdash.com/api-reference/integrations/connect-jira

Starts the Jira OAuth process by providing the organization's Atlassian OAuth 2.0 client credentials.

```APIDOC
## POST /api/v1/jira/install

### Description
Start Jira OAuth with the organization's own Atlassian OAuth 2.0 app.

### Method
POST

### Endpoint
/api/v1/jira/install

### Request Body
- **clientId** (string) - Required - The client ID of the Atlassian OAuth 2.0 app.
- **clientSecret** (string) - Required - The client secret of the Atlassian OAuth 2.0 app.

### Request Example
{
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret"
}

### Response
#### Success Response (200)
- **status** (string) - The status of the request (e.g., "ok").
- **results** (object) - The result object containing the install URL.
  - **installUrl** (string) - The URL to initiate the Jira OAuth flow.

#### Response Example
{
  "status": "ok",
  "results": {
    "installUrl": "https://auth.atlassian.com/..."
  }
}
```

--------------------------------

### GET /api/v1/linear/install

Source: https://docs.lightdash.com/api-reference/integrations/connect-linear

Initiates the Linear OAuth flow with PKCE for the user.

```APIDOC
## GET /api/v1/linear/install

### Description
Start Linear OAuth with PKCE.

### Method
GET

### Endpoint
/api/v1/linear/install

### Parameters
#### Query Parameters
- **clientId** (string) - Optional - The client ID for the integration.

### Response
#### Success Response (302)
- Redirect to Linear OAuth
```

--------------------------------

### OpenAPI definition for List resource types

Source: https://docs.lightdash.com/api-reference/scim/list-resource-types

The OpenAPI specification for the GET /api/v1/scim/v2/ResourceTypes endpoint, including the response schema and example JSON output.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/scim/v2/ResourceTypes:
    get:
      tags:
        - SCIM
      summary: List resource types
      description: Get SCIM resource types
      operationId: GetScimResourceTypes
      parameters: []
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimListResponse_ScimResourceType_'
              examples:
                Example 1:
                  value:
                    schemas:
                      - urn:ietf:params:scim:api:messages:2.0:ListResponse
                    totalResults: 3
                    itemsPerPage: 3
                    startIndex: 1
                    Resources:
                      - schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                        id: User
                        name: User
                        description: User Account
                        endpoint: /Users
                        schema: urn:ietf:params:scim:schemas:core:2.0:User
                        schemaExtensions:
                          - schema: >-
                              urn:lightdash:params:scim:schemas:extension:2.0:User
                            required: false
                        meta:
                          resourceType: ResourceType
                          location: >-
                            https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/User
                      - schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                        id: Group
                        name: Group
                        description: Group
                        endpoint: /Groups
                        schema: urn:ietf:params:scim:schemas:core:2.0:Group
                        meta:
                          resourceType: ResourceType
                          location: >-
                            https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/Group
                      - schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                        id: Role
                        name: Role
                        description: Role
                        endpoint: /Roles
                        schema: urn:ietf:params:scim:schemas:extension:2.0:Role
                        meta:
                          resourceType: ResourceType
                          location: >-
                            https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/Role
      security: []
components:
```

--------------------------------

### Clone and Login with Lightdash CLI

Source: https://docs.lightdash.com/get-started/quickstart/connect-project

Clone the Supabase quickstart repository and authenticate the Lightdash CLI.

```bash
git clone git@github.com:lightdash/lightdash-supabase-quickstart.git
cd lightdash-supabase-quickstart
npm install -g @lightdash/cli
lightdash login https://app.lightdash.cloud --token <your-token>
```

--------------------------------

### OpenAPI Specification for List SCIM Schemas

Source: https://docs.lightdash.com/api-reference/scim/list-schemas

The OpenAPI definition for the GET /api/v1/scim/v2/Schemas endpoint, including the response schema and an example JSON payload.

```yaml
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.125.0
  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: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/scim/v2/Schemas:
    get:
      tags:
        - SCIM
      summary: List schemas
      description: Get SCIM schemas
      operationId: GetScimSchemas
      parameters: []
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimListResponse_ScimSchema_'
              examples:
                Example 1:
                  value:
                    schemas:
                      - urn:ietf:params:scim:api:messages:2.0:ListResponse
                    totalResults: 1
                    itemsPerPage: 1
                    startIndex: 1
                    Resources:
                      - schemas:
                          - urn:ietf:params:scim:schemas:core:2.0:Schema
                        id: urn:ietf:params:scim:schemas:extension:2.0:Role
                        name: Role
                        description: Role Schema
                        attributes:
                          - name: value
                            type: string
                            multiValued: false
                            description: The value of the role
                            required: true
                            caseExact: false
                            mutability: readOnly
                            returned: default
                            uniqueness: none
                          - name: display
                            type: string
                            multiValued: false
                            description: Human-readable name for the role
                            required: false
                            caseExact: false
                            mutability: readOnly
                            returned: default
                            uniqueness: none
                          - name: type
                            type: string
                            multiValued: false
                            description: Label indicating the role function
                            required: false
                            caseExact: false
                            mutability: readOnly
                            returned: default
                            uniqueness: none
                          - name: supported
                            type: boolean
                            multiValued: false
                            description: Boolean indicating if the role is usable
                            required: true
                            caseExact: false
                            mutability: readOnly
```

--------------------------------

### Initialize Lightdash Client and Execute Query

Source: https://docs.lightdash.com/sdk/python-sdk

Demonstrates how to initialize the Lightdash client and execute a query using the chainable builder pattern to retrieve results as a DataFrame or list of dictionaries.

```python
from lightdash import Client

client = Client(
    instance_url="https://app.lightdash.cloud",
    access_token="your-token",
    project_uuid="your-uuid",
)
model = client.get_model("orders")

# Build and execute a query
result = (
    model.query()
    .metrics(model.metrics.revenue, model.metrics.profit)
    .dimensions(model.dimensions.country)
    .filter(model.dimensions.status == "active")
    .sort(model.metrics.revenue.desc())
    .limit(100)
    .execute()
)

# Get results as a DataFrame
df = result.to_df()

# Or as a list of dictionaries
records = result.to_records()
```

--------------------------------

### GET /api/v1/github/repos/list

Source: https://docs.lightdash.com/api-reference/list-github-repositories

Retrieves a list of GitHub repositories accessible via the installed app. Requires permission to manage the organization's Git integration.

```APIDOC
## GET /api/v1/github/repos/list

### Description
List GitHub repositories accessible via the installed app. Requires permission to manage the organization's Git integration.

### Method
GET

### Endpoint
/api/v1/github/repos/list

### Response
#### Success Response (200)
- **results** (array) - List of GitRepo objects
- **status** (string) - Status of the request (e.g., "ok")

#### Response Example
{
  "status": "ok",
  "results": [
    {
      "name": "my-repo",
      "fullName": "owner/my-repo",
      "ownerLogin": "owner",
      "defaultBranch": "main",
      "provider": "github",
      "writable": true
    }
  ]
}
```

--------------------------------

### Extra instructions configuration

Source: https://docs.lightdash.com/data-apps/customize-themes

Example of the content to input into the Extra instructions field within the theme detail panel. These directives guide the agent on formatting and layout preferences.

```text
Use sentence case for all headings. Prefer dense layouts over generous whitespace.
Always show the company logo in the top-left corner of the app.
```
Tokens:
Raw