---
title: "Get a shared dashboard"
method: GET
path: "/api/v1/dashboard/public/{token}"
tags: ["Dashboards"]
---

# Get a shared dashboard

`GET /api/v1/dashboard/public/{token}`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v1/dashboard/public/{token}`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `dashboards_read`

Fetch an existing shared dashboard's sharing metadata associated with the specified token.

## Path parameters

- `token` string, required

## Response `200`

OK

- SharedDashboard: The metadata object associated with how a dashboard has been/will be shared.
  - `author` SharedDashboardAuthor: User who shared the dashboard.
    - `handle` string: Identifier of the user who shared the dashboard.
    - `name` string, nullable: Name of the user who shared the dashboard.
  - `created` string, date-time: Date the dashboard was shared.
  - `dashboard_id` string, required: ID of the dashboard to share.
  - `dashboard_type` 'custom_timeboard' | 'custom_screenboard', required: The type of the associated private dashboard.
  - `embeddable_domains` string[]: The `SharedDashboard` `embeddable_domains`.
  - `expiration` string, date-time, nullable: The time when an OPEN shared dashboard becomes publicly unavailable.
  - `global_time` DashboardGlobalTime: Object containing the live span selection for the dashboard.
    - `live_span` '15m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo': Dashboard global time live_span selection
  - `global_time_selectable_enabled` boolean, nullable: Whether to allow viewers to select a different global time setting for the shared dashboard.
  - `invitees` SharedDashboardInviteesItems[]: The `SharedDashboard` `invitees`.
    - `access_expiration` string, date-time, nullable: Time of the invitee expiration. Null means the invite will not expire.
    - `created_at` string, date-time: Time that the invitee was created.
    - `email` string, required: Email of the invitee.
  - `last_accessed` string, date-time, nullable: The last time the shared dashboard was accessed. Null if never accessed.
  - `public_url` string: URL of the shared dashboard.
  - `selectable_template_vars` SelectableTemplateVariableItems[], nullable: List of objects representing template variables on the shared dashboard which can have selectable values.
    - `default_value` string: The default value of the template variable.
    - `name` string: Name of the template variable.
    - `prefix` string: The tag/attribute key associated with the template variable.
    - `type` string, nullable: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
    - `visible_tags` string[], nullable: List of visible tag values on the shared dashboard.
  - `share_list` string[], nullable: List of email addresses that can receive an invitation to access to the shared dashboard.
  - `share_type` 'open' | 'invite' | 'embed', nullable: Type of sharing access (either open to anyone who has the public URL or invite-only).
  - `status` 'active' | 'paused': Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.
  - `title` string: Title of the shared dashboard.
  - `token` string: A unique token assigned to the shared dashboard.
  - `viewing_preferences` ViewingPreferences: The viewing preferences for a shared dashboard.
    - `high_density` boolean: Whether the widgets on the shared dashboard should be displayed with high density.
    - `theme` 'system' | 'light' | 'dark': The theme of the shared dashboard view. "system" follows your system's default viewing theme.

## Other responses

- `403`: Forbidden
- `404`: Shared Dashboard Not Found
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v1-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/revisions/ca5871004d26?raw)