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

# Retrieve dashboard

> Get a dashboard by UID.

<Note>
  If you authenticate with an API token, you can only retrieve a dashboard shared with everyone in your organization or with a group. You can't retrieve private dashboards.
</Note>


## OpenAPI

````yaml v2 get /dashboards/uid/{uid}
openapi: 3.0.0
info:
  description: A public and stable API for interacting with axiom services
  title: Axiom
  termsOfService: http://axiom.co/terms
  contact:
    name: Axiom support team
    url: https://axiom.co
    email: hello@axiom.co
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
  - url: https://api.axiom.co/v2/
security:
  - bearerAuth: []
paths:
  /dashboards/uid/{uid}:
    get:
      tags:
        - dashboards
      summary: Get dashboard
      description: Get a dashboard by UID.
      operationId: getDashboard
      parameters:
        - name: uid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dashboard
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResource'
        '404':
          description: Dashboard not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardError'
      security:
        - bearerAuth: []
components:
  schemas:
    DashboardResource:
      type: object
      required:
        - uid
        - id
        - version
        - dashboard
        - createdAt
        - updatedAt
        - createdBy
        - updatedBy
      properties:
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        dashboard:
          $ref: '#/components/schemas/DashboardDocument'
        id:
          type: string
        uid:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        version:
          type: integer
          format: int64
    DashboardError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        currentVersion:
          type: integer
          format: int64
        message:
          type: string
        reason:
          type: string
        uid:
          type: string
    DashboardDocument:
      $ref: '#/components/schemas/Dashboard'
      type: object
      additionalProperties: true
    Dashboard:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        owner:
          $ref: '#/components/schemas/Owner'
        description:
          type: string
          maxLength: 1000
        charts:
          maxItems: 200
          type: array
          items:
            $ref: '#/components/schemas/Chart'
        layout:
          maxItems: 200
          type: array
          items:
            $ref: '#/components/schemas/LayoutItem'
        refreshTime:
          type: integer
          enum:
            - 15
            - 60
            - 300
        schemaVersion:
          $ref: '#/components/schemas/SchemaVersion'
        against:
          type: string
          enum:
            - '-1h'
            - '-3h'
            - '-6h'
            - '-12h'
            - '-1d'
            - '-3d'
            - '-7d'
            - '-1w'
            - '-2w'
            - '-3w'
            - '-30d'
            - '-60d'
            - '-90d'
          description: >-
            Relative time comparison offset. Compares the current time window
            against a previous period offset by this duration. Mutually
            exclusive with `againstTimestamp` — setting one clears the other.
            Use an empty string or omit to disable comparison.
        againstTimestamp:
          $ref: '#/components/schemas/DatetimeString'
          description: >-
            Absolute or relative timestamp to compare against. Mutually
            exclusive with `against` — setting one clears the other. Accepts ISO
            8601, `now-{duration}` (e.g. `now-1h`), or epoch milliseconds as a
            string.
        timeWindowStart:
          $ref: '#/components/schemas/TimeWindowStart'
        timeWindowEnd:
          $ref: '#/components/schemas/TimeWindowEnd'
        uid:
          $ref: '#/components/schemas/DashboardUID'
      required:
        - name
        - owner
        - charts
        - layout
        - refreshTime
        - schemaVersion
        - timeWindowStart
        - timeWindowEnd
      additionalProperties: false
    Owner:
      type: string
      description: >-
        User ID of the dashboard owner. Use `X-AXIOM-EVERYONE` to make the
        dashboard accessible to all users in the organization.
    Chart:
      oneOf:
        - $ref: '#/components/schemas/TimeSeriesChart'
        - $ref: '#/components/schemas/HeatmapChart'
        - $ref: '#/components/schemas/LogStreamChart'
        - $ref: '#/components/schemas/PieChart'
        - $ref: '#/components/schemas/ScatterChart'
        - $ref: '#/components/schemas/TableChart'
        - $ref: '#/components/schemas/TopKChart'
        - $ref: '#/components/schemas/StatisticChart'
        - $ref: '#/components/schemas/NoteChart'
        - $ref: '#/components/schemas/MonitorListChart'
        - $ref: '#/components/schemas/SmartFilterChart'
        - $ref: '#/components/schemas/SpacerChart'
    LayoutItem:
      type: object
      properties:
        i:
          $ref: '#/components/schemas/ChartId'
        x:
          type: integer
          minimum: 0
          maximum: 11
        'y':
          nullable: true
          type: integer
          minimum: 0
          maximum: 9007199254740991
        w:
          type: integer
          minimum: 1
          maximum: 12
        h:
          type: integer
          minimum: 1
          maximum: 100
        minW:
          type: integer
          minimum: 1
          maximum: 12
        minH:
          type: number
          minimum: 0.5
          maximum: 100
        maxW:
          type: integer
          minimum: 1
          maximum: 12
        maxH:
          type: integer
          minimum: 1
          maximum: 100
        static:
          type: boolean
      required:
        - i
        - x
        - 'y'
        - w
        - h
      additionalProperties: false
    SchemaVersion:
      type: integer
      enum:
        - 2
    DatetimeString:
      type: string
      maxLength: 100
      description: >-
        A datetime value. Accepts ISO 8601 (e.g. `2024-01-02T00:00:00.000Z`),
        relative time using `now-{duration}` where duration is a number followed
        by `s` (seconds), `m` (minutes), `h` (hours), `d` (days), or `w` (weeks)
        (e.g. `now-1h`, `now-7d`), a Unix epoch millisecond timestamp as a
        string (e.g. `1704067200000`), or an empty string to clear the value.
    TimeWindowStart:
      type: string
      minLength: 1
      maxLength: 100
      description: >-
        Start of the dashboard time range. Use `qr-now-{duration}` for a quick
        range relative to now, where duration is a number followed by `s`
        (seconds), `m` (minutes), `h` (hours), `d` (days), or `w` (weeks).
        Examples: `qr-now-5m`, `qr-now-1h`, `qr-now-7d`. Alternatively, use a
        Unix epoch millisecond timestamp as a string (e.g. `1704067200000`).
    TimeWindowEnd:
      type: string
      minLength: 1
      maxLength: 100
      description: >-
        End of the dashboard time range. Use `qr-now` for a rolling window that
        tracks the current time (pair with a `qr-now-{duration}` start), or a
        Unix epoch millisecond timestamp as a string (e.g. `1704153600000`).
    DashboardUID:
      type: string
      pattern: ^[A-Za-z0-9_-]{1,128}$
      description: >-
        Optional dashboard UID. Must contain only letters, numbers, underscores,
        or hyphens, with length 1-128 when provided.
    TimeSeriesChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - TimeSeries
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/TimeSeriesChartQuery'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Timeseries
    HeatmapChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Heatmap
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/HeatmapChartQuery'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Heatmap
    LogStreamChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - LogStream
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
        tableSettings:
          $ref: '#/components/schemas/TableSettings'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Log stream
    PieChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Pie
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Pie
    ScatterChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Scatter
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Scatter
    TableChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Table
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
        tableSettings:
          $ref: '#/components/schemas/TableSettings'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Table
    TopKChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - TopK
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Top list
    StatisticChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Statistic
        name:
          type: string
          minLength: 1
          maxLength: 500
        query:
          $ref: '#/components/schemas/SimpleChartQuery'
        colorScheme:
          type: string
          enum:
            - Blue
            - Orange
            - Red
            - Purple
            - Teal
            - Yellow
            - Green
            - Pink
            - Grey
            - Brown
        customUnits:
          type: string
          maxLength: 200
        showChart:
          anyOf:
            - type: boolean
            - type: string
        hideValue:
          type: boolean
        chartHeight:
          anyOf:
            - type: string
              maxLength: 100
            - type: number
        errorThreshold:
          type: string
          enum:
            - Above
            - AboveOrEqual
            - Below
            - BelowOrEqual
            - AboveOrBelow
        errorThresholdValue:
          type: string
          maxLength: 100
        warningThreshold:
          type: string
          enum:
            - Above
            - AboveOrEqual
            - Below
            - BelowOrEqual
            - AboveOrBelow
        warningThresholdValue:
          type: string
          maxLength: 100
        invertTheme:
          type: boolean
        background:
          $ref: '#/components/schemas/CssColor'
        textColor:
          $ref: '#/components/schemas/CssColor'
        labelColor:
          $ref: '#/components/schemas/CssColor'
        chartFillColor:
          $ref: '#/components/schemas/CssColor'
        okColorProps:
          $ref: '#/components/schemas/StatisticChartColorProps'
        warningColorProps:
          $ref: '#/components/schemas/StatisticChartColorProps'
        errorColorProps:
          $ref: '#/components/schemas/StatisticChartColorProps'
      required:
        - id
        - type
        - query
      additionalProperties: false
      title: Statistic
    NoteChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Note
        text:
          type: string
          minLength: 1
          maxLength: 100000
        variant:
          type: string
          enum:
            - default
      required:
        - id
        - type
        - text
      additionalProperties: false
      title: Note
    MonitorListChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - MonitorList
        name:
          type: string
          minLength: 1
          maxLength: 500
        selectedMonitors:
          minItems: 1
          maxItems: 200
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 200
        columns:
          $ref: '#/components/schemas/MonitorListColumns'
      required:
        - id
        - type
        - selectedMonitors
        - columns
      additionalProperties: false
      title: Monitor list
    SmartFilterChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - SmartFilter
        name:
          type: string
          minLength: 1
          maxLength: 500
        filters:
          minItems: 1
          maxItems: 50
          type: array
          items:
            $ref: '#/components/schemas/SmartFilterConfig'
        logo:
          $ref: '#/components/schemas/LogoUrl'
        logoDark:
          $ref: '#/components/schemas/LogoUrl'
      required:
        - id
        - type
        - filters
      additionalProperties: false
      title: Filter bar
    SpacerChart:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ChartId'
        type:
          type: string
          enum:
            - Spacer
        name:
          type: string
          minLength: 1
          maxLength: 500
      required:
        - id
        - type
      additionalProperties: false
      title: Spacer
    ChartId:
      type: string
      minLength: 1
      maxLength: 200
    TimeSeriesChartQuery:
      anyOf:
        - $ref: '#/components/schemas/TimeSeriesNonMetricsAplQuery'
        - $ref: '#/components/schemas/TimeSeriesNativeMplQuery'
      title: ChartQuery
    HeatmapChartQuery:
      anyOf:
        - $ref: '#/components/schemas/HeatmapNonMetricsAplQuery'
        - $ref: '#/components/schemas/HeatmapNativeMplQuery'
      title: ChartQuery
    SimpleChartQuery:
      anyOf:
        - $ref: '#/components/schemas/SimpleNonMetricsAplQuery'
        - $ref: '#/components/schemas/SimpleNativeMplQuery'
      title: ChartQuery
    TableSettings:
      type: object
      properties:
        columns:
          maxItems: 500
          type: array
          items:
            $ref: '#/components/schemas/ColumnSetting'
        settings:
          $ref: '#/components/schemas/DatasetStreamSettings'
      additionalProperties: false
    CssColor:
      type: string
      maxLength: 200
    StatisticChartColorProps:
      type: object
      properties:
        background:
          $ref: '#/components/schemas/CssColor'
        chartFillColor:
          $ref: '#/components/schemas/CssColor'
        labelColor:
          $ref: '#/components/schemas/CssColor'
        textColor:
          $ref: '#/components/schemas/CssColor'
      additionalProperties: false
    MonitorListColumns:
      type: object
      properties:
        status:
          type: boolean
        history:
          type: boolean
        dataset:
          type: boolean
        type:
          type: boolean
        notifiers:
          type: boolean
      required:
        - status
        - history
        - dataset
        - type
        - notifiers
      additionalProperties: false
    SmartFilterConfig:
      oneOf:
        - $ref: '#/components/schemas/SmartFilterSearch'
        - $ref: '#/components/schemas/SmartFilterSelect'
    LogoUrl:
      type: string
      maxLength: 2000
    TimeSeriesNonMetricsAplQuery:
      type: object
      properties:
        apl:
          $ref: '#/components/schemas/AplString'
        queryOptions:
          $ref: '#/components/schemas/TimeSeriesQueryOptions'
      required:
        - apl
      additionalProperties: false
      title: APL
    TimeSeriesNativeMplQuery:
      type: object
      properties:
        mpl:
          $ref: '#/components/schemas/MplString'
        queryOptions:
          $ref: '#/components/schemas/TimeSeriesQueryOptions'
      required:
        - mpl
      additionalProperties: false
      title: MPL
    HeatmapNonMetricsAplQuery:
      type: object
      properties:
        apl:
          $ref: '#/components/schemas/AplString'
        queryOptions:
          $ref: '#/components/schemas/HeatmapQueryOptions'
      required:
        - apl
      additionalProperties: false
      title: APL
    HeatmapNativeMplQuery:
      type: object
      properties:
        mpl:
          $ref: '#/components/schemas/MplString'
        queryOptions:
          $ref: '#/components/schemas/HeatmapQueryOptions'
      required:
        - mpl
      additionalProperties: false
      title: MPL
    SimpleNonMetricsAplQuery:
      type: object
      properties:
        apl:
          $ref: '#/components/schemas/AplString'
      required:
        - apl
      additionalProperties: false
      title: APL
    SimpleNativeMplQuery:
      type: object
      properties:
        mpl:
          $ref: '#/components/schemas/MplString'
      required:
        - mpl
      additionalProperties: false
      title: MPL
    ColumnSetting:
      oneOf:
        - type: string
          maxLength: 500
        - $ref: '#/components/schemas/AdvancedColumnSetting'
    DatasetStreamSettings:
      type: object
      properties:
        fontSize:
          type: string
          maxLength: 20
          pattern: ^\d+px$
        highlightSeverity:
          type: boolean
        showRaw:
          type: boolean
        showEvent:
          type: boolean
        showTimestamp:
          type: boolean
        wrapLines:
          type: boolean
        hideNulls:
          type: boolean
        fitColumns:
          type: boolean
      additionalProperties: false
    SmartFilterSearch:
      type: object
      properties:
        __isPlaceholderData:
          $ref: '#/components/schemas/SmartFilterIsPlaceholderData'
        id:
          $ref: '#/components/schemas/SmartFilterId'
        name:
          $ref: '#/components/schemas/SmartFilterName'
        active:
          $ref: '#/components/schemas/SmartFilterActive'
        options:
          $ref: '#/components/schemas/SmartFilterOptions'
        datasetId:
          $ref: '#/components/schemas/SmartFilterDatasetId'
        type:
          type: string
          enum:
            - search
      required:
        - id
        - type
      additionalProperties: false
      title: SmartFilterSearch
    SmartFilterSelect:
      type: object
      properties:
        __isPlaceholderData:
          $ref: '#/components/schemas/SmartFilterIsPlaceholderData'
        id:
          $ref: '#/components/schemas/SmartFilterId'
        name:
          $ref: '#/components/schemas/SmartFilterName'
        active:
          $ref: '#/components/schemas/SmartFilterActive'
        options:
          $ref: '#/components/schemas/SmartFilterOptions'
        datasetId:
          $ref: '#/components/schemas/SmartFilterDatasetId'
        type:
          type: string
          enum:
            - select
        selectType:
          $ref: '#/components/schemas/SmartFilterSelectType'
        apl:
          $ref: '#/components/schemas/SmartFilterApl'
      required:
        - id
        - type
      additionalProperties: false
      title: SmartFilterSelect
    AplString:
      type: string
      minLength: 1
      maxLength: 500000
    TimeSeriesQueryOptions:
      type: object
      properties:
        displayNull:
          type: string
          enum:
            - auto
            - 'null'
            - span
            - zero
            - ''
          description: >-
            Controls how empty intervals are rendered in time series charts.
            `auto` infers from the query, `null` leaves gaps, `span` connects
            adjacent points, `zero` fills with zero.
        overlayCharts:
          $ref: '#/components/schemas/BooleanString'
          description: >-
            When enabled, charts are overlaid on a single chart instead of
            stacked separately.
        shownColumns:
          type: string
          maxLength: 10000
        timeSeriesVariant:
          type: string
          enum:
            - area
            - bars
            - line
            - lines
            - ''
        timeSeriesView:
          type: string
          enum:
            - charts
            - resultsTable
            - charts|resultsTable
            - ''
      additionalProperties: false
    MplString:
      type: string
      minLength: 1
      maxLength: 500000
      title: MplString
    HeatmapQueryOptions:
      type: object
      properties:
        timeSeriesView:
          type: string
          enum:
            - charts
            - resultsTable
            - charts|resultsTable
            - ''
      additionalProperties: false
    AdvancedColumnSetting:
      type: object
      properties:
        name:
          type: string
          maxLength: 500
        width:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
      required:
        - name
      additionalProperties: false
    SmartFilterIsPlaceholderData:
      type: boolean
    SmartFilterId:
      type: string
      maxLength: 200
    SmartFilterName:
      type: string
      maxLength: 200
    SmartFilterActive:
      type: boolean
    SmartFilterOptions:
      anyOf:
        - maxItems: 200
          type: array
          items:
            $ref: '#/components/schemas/SmartFilterOption'
        - type: string
          nullable: true
          enum:
            - null
        - type: string
          enum:
            - ''
    SmartFilterDatasetId:
      type: string
      maxLength: 200
    SmartFilterSelectType:
      nullable: true
      type: string
      enum:
        - list
        - apl
        - ''
    SmartFilterApl:
      title: SmartFilterApl
      allOf:
        - anyOf:
            - 3c7ba731-9c69-45bc-aaa0-a19cd793a92a
            - $ref: '#/components/schemas/EmptyAplObject'
    BooleanString:
      type: string
      enum:
        - 'true'
        - 'false'
        - ''
    SmartFilterOption:
      type: object
      properties:
        id:
          type: string
          maxLength: 200
        key:
          type: string
          maxLength: 500
        value:
          type: string
          maxLength: 10000
        default:
          type: boolean
      required:
        - key
        - value
      additionalProperties: false
    EmptyAplObject:
      type: object
      properties:
        apl:
          type: string
          enum:
            - ''
      required:
        - apl
      additionalProperties: {}
      title: EmptyAplObject
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using an API token or personal access token (PAT). Include
        the token as a Bearer token: `Authorization: Bearer <token>`. For more
        information, see [Tokens](/reference/tokens).

````