---
title: "Get dashboard by ID"
method: GET
path: "/api/analytics/dashboards/{dashboardId}"
tags: ["analytics"]
---

# Get dashboard by ID

`GET /api/analytics/dashboards/{dashboardId}`

## Request

- Base URL: `https://codescene.io` (the document declares no server; this is the origin it was published from)
- URL: `https://codescene.io/api/analytics/dashboards/{dashboardId}`
- Auth: none declared

## Path parameters

- `dashboardId` integer, required

## Response `200`

- object
  - `dashboard` object, required
    - `id` integer, required
    - `name` string, required
    - `owner` object, required
      - `id` union, required
        - integer
        - string
      - `name` string, required
    - `query` object, required
      - `type` 'project-aggregation', required
      - `nameParams` object[], required
        - `name` string, required
        - `value` string, nullable, required
        - `sortOrder` integer, required
      - `tagsFilter` unknown
    - `visibility` object, required
      - `published` boolean, required
    - `permissions` object, required
      - `canEdit` boolean, required
      - `canDelete` boolean, required
    - `dateRange` union, required
      - object
        - `rangeType` 'relative', required
        - `unit` 'week' | 'month' | 'quarter' | 'year', required
      - object
        - `rangeType` 'absolute', required
        - `startDate` string, required
        - `endDate` string, required
    - `widgets` object[], required
      - `id` integer, required
      - `variantId` string, required
      - `type` 'kpiCard' | 'lineChart' | 'table' | 'histogram' | 'systemMap' | 'aiText', required
      - `inputs` union[], required
        - union
          - object
            - `type` 'metric', required
            - `value` string, required
            - `internalId` string
            - `label` string
          - object
            - `type` 'queryKey', required
            - `value` string, required
            - `internalId` string
            - `label` string
          - object
            - `type` 'number', required
            - `value` number, required
            - `internalId` string
            - `label` string
      - `layout` 'narrow' | 'quarter' | 'third' | 'half' | 'full' | 'main'
      - `placement` object
        - `colSpan` integer, required
        - `rowSpan` integer, required
        - `detail` 'compact' | 'standard' | 'detailed'
      - `title` string, nullable
      - `position` integer
      - `query` object
        - `type` 'project-aggregation', required
        - `nameParams` object[], required
          - `name` string, required
          - `value` string, nullable, required
          - `sortOrder` integer, required
        - `tagsFilter` unknown
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable

## Other responses

- `400`
- `401`
- `403`
- `404`

---

[API](https://skmtc.dev/codescene/apis/codescene-api.md) · [All operations](https://skmtc.dev/codescene/apis/codescene-api/llms.txt) · [OpenAPI document](https://skmtc.dev/codescene/apis/codescene-api/revisions/e443e0b6bc89?raw)