---
title: "Get Dashboard based on url"
method: GET
path: "/dashboards/url/{url}"
tags: ["Dashboard"]
---

# Get Dashboard based on url

`GET /dashboards/url/{url}`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/url/{url}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Retrieve details of a specific dashboard by its url

## Path parameters

- `url` string, required

## Response `200`

Request fulfilled, document follows

- union
  - ShareDashboardHtmlType
    - `html` string, required
    - `title` string, required
    - `id` integer, required: ID of the dashboard
    - `auth_type` string, required: Authentication type for the dashboard
    - `was_published` boolean, required: Whether the dashboard was ever published
    - `project_id` integer, nullable: Source project id — always null for viewers
    - `workspace_id` integer, nullable: Source workspace id — always null for viewers
  - V3DashboardMetaType
    - `id` integer, required: ID of the dashboard
    - `title` string, required
    - `share` DashboardAuth
      - `type_of_auth` 'mammoth' | 'public' | 'password', required: Type of authentication for sharing the dashboard.
      - `options` object, nullable: Options for sharing the dashboard, such as expiration date or access level.
      - `sequence` integer, nullable: Published presentation sequence — the draft version number the shared/published presentation was last synced to. Read from the share JSON (set by the presentation-publish path); the viewer uses it to cache-bust the published thumbnail/OG artifacts.
    - `url` string, required
    - `engine` string: Which engine draws this dashboard. Both the viewer link and the editor link have a route per engine, and a dashboard opened on the other engine's route draws a blank page, so a client builds either link from this.
    - `was_published` boolean, required: Whether the dashboard was ever published
    - `sources` integer[]: Parent source view ids
    - `auto_sync` object: Mapping of view_id to configuration & sync status
    - `auto_publish` boolean: Whether auto-publish is enabled for the dashboard
    - `is_sync_pending` boolean: Whether the dashboard draft sync is pending (not in sync with sources)
    - `is_publish_pending` boolean: Whether the dashboard publish is pending (draft differs from published)
    - `is_publish_presentation_pending` boolean: Whether the dashboard's shared presentation is out of date
    - `unpublished_authors` UnpublishedAuthor[]: Who wrote the draft versions a live board has not published yet, most versions first (empty on a draft board)
      - `user_id` integer, required: Who wrote the unpublished versions
      - `user_name` string: Their display name
      - `count` integer, required: How many unpublished versions
    - `role` string, nullable: The caller's effective role (dashboard_editor/dashboard_viewer)
    - `project_id` integer, nullable: The project that owns the dashboard; null for viewers from outside the project
    - `unavailable_files` UnavailableFileType[]: The files of the caller's own saved board that they can no longer open; non-empty means the board must not open in the editor
      - `id` integer, required
      - `name` string, required

## Other responses

- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)