> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lightdash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get tile parameter references

> List the parameters each dashboard tile uses, read from its saved query
without running it. Tiles that can't be loaded or viewed report an error.
The dashboard calls this while it is edited; in view mode each tile
reports its parameters with its own query results.

Embed tokens can call this with the `Lightdash-Embed-Token` header. The
token must embed a dashboard: only that dashboard's tiles are listed,
with the charts saved on it (request chart uuids are ignored), and a
tile not on it reports an error.



## OpenAPI

````yaml https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json post /api/v2/projects/{projectUuid}/dashboards/tile-parameter-references
openapi: 3.0.0
info:
  title: Lightdash API
  version: 3.154.0
  description: >
    Open API documentation for all public Lightdash API endpoints. #
    Authentication Authenticate using the Authorization header with either
    'ApiKey <personal-access-token>' or 'Bearer <service-account-token>'. Create
    a Personal Access Token by following this guide:
    https://docs.lightdash.com/references/personal_tokens Self-hosted
    provisioning can use the admin token configured with
    LD_SETUP_SERVICE_ACCOUNT_TOKEN to create scoped service accounts through the
    Service Accounts API.
  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: Service Accounts
    description: >-
      Create and manage machine credentials for your organization. Requires
      organization administration permission. Use predefined organization
      scopes, a custom organization role, or grants to selected projects.
      Credentials cannot grant more access than the caller holds.
  - 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/v2/projects/{projectUuid}/dashboards/tile-parameter-references:
    post:
      tags:
        - v2
        - Dashboards
      summary: Get tile parameter references
      description: >-
        List the parameters each dashboard tile uses, read from its saved query

        without running it. Tiles that can't be loaded or viewed report an
        error.

        The dashboard calls this while it is edited; in view mode each tile

        reports its parameters with its own query results.


        Embed tokens can call this with the `Lightdash-Embed-Token` header. The

        token must embed a dashboard: only that dashboard's tiles are listed,

        with the charts saved on it (request chart uuids are ignored), and a

        tile not on it reports an error.
      operationId: getDashboardTileParameterReferences
      parameters:
        - in: path
          name: projectUuid
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardTileParameterReferencesRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiDashboardTileParameterReferencesResponse
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    DashboardTileParameterReferencesRequest:
      properties:
        tiles:
          items:
            $ref: '#/components/schemas/DashboardTileParameterReferencesTile'
          type: array
      required:
        - tiles
      type: object
    ApiDashboardTileParameterReferencesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/DashboardTileParameterReferences'
          type: array
        status:
          type: string
          enum:
            - ok
          nullable: false
      required:
        - results
        - status
      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
          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
    DashboardTileParameterReferencesTile:
      properties:
        savedSqlUuid:
          type: string
          nullable: true
        savedChartUuid:
          type: string
          nullable: true
        tileUuid:
          type: string
      required:
        - savedSqlUuid
        - savedChartUuid
        - tileUuid
      type: object
    DashboardTileParameterReferences:
      anyOf:
        - properties:
            error:
              type: number
              enum:
                - null
              nullable: true
            parameterDefinitions:
              $ref: '#/components/schemas/ParameterDefinitions'
            parameterReferences:
              items:
                type: string
              type: array
            tileUuid:
              type: string
          required:
            - error
            - parameterReferences
            - tileUuid
          type: object
        - properties:
            error:
              type: string
            parameterReferences:
              type: number
              enum:
                - null
              nullable: true
            tileUuid:
              type: string
          required:
            - error
            - parameterReferences
            - tileUuid
          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.
    ParameterDefinitions:
      $ref: '#/components/schemas/Record_string.LightdashProjectParameter_'
    Record_string.LightdashProjectParameter_:
      properties: {}
      additionalProperties:
        $ref: '#/components/schemas/LightdashProjectParameter'
      type: object
      description: Construct a type with a set of properties K of type T
    LightdashProjectParameter:
      properties:
        options_from_dimension:
          properties:
            dimension:
              type: string
            model:
              type: string
          required:
            - dimension
            - model
          type: object
        options:
          anyOf:
            - items:
                type: string
              type: array
            - items:
                type: number
                format: double
              type: array
            - items:
                $ref: '#/components/schemas/LightdashParameterOption'
              type: array
        allow_custom_values:
          type: boolean
        multiple:
          type: boolean
        default:
          $ref: '#/components/schemas/ParameterValue'
        type:
          type: string
          enum:
            - string
            - number
            - date
        description:
          type: string
        label:
          type: string
      required:
        - label
      type: object
    LightdashParameterOption:
      properties:
        value:
          anyOf:
            - type: string
            - type: number
              format: double
        label:
          type: string
      required:
        - value
        - label
      type: object
    ParameterValue:
      anyOf:
        - type: string
        - type: number
          format: double
        - items:
            type: string
          type: array
        - items:
            type: number
            format: double
          type: array

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.