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

# Dashboards

> Create, retrieve, update, list, and delete dashboard entities with charts, owners, tags, and domains within a dashboard service using the Collate REST API.

# Dashboards

A **Dashboard** is a visual collection of charts and data views within a Dashboard Service. It sits below the service and contains Charts.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/dashboards/dashboard/).
</Info>

## Entity Hierarchy

Dashboards belong to a Dashboard Service:

<CodeGroup>
  ```txt Dashboard theme={null}
  DashboardService
  └── Dashboard (this page)
      └── Chart
  ```
</CodeGroup>

## Fully Qualified Name

The FQN format for a dashboard is:

```
service.dashboardName
```

For example: `sample_superset.10`

***

## API Endpoints

| Method   | Endpoint                                 | Description                                                                       |
| -------- | ---------------------------------------- | --------------------------------------------------------------------------------- |
| `PUT`    | `/v1/dashboards`                         | [Create or update a dashboard](/api-reference/data-assets/dashboards/create)      |
| `POST`   | `/v1/dashboards`                         | [Create a dashboard (POST variant)](/api-reference/data-assets/dashboards/create) |
| `GET`    | `/v1/dashboards`                         | [List dashboards](/api-reference/data-assets/dashboards/list)                     |
| `GET`    | `/v1/dashboards/{id}`                    | [Get by ID](/api-reference/data-assets/dashboards/retrieve)                       |
| `GET`    | `/v1/dashboards/name/{fqn}`              | [Get by FQN](/api-reference/data-assets/dashboards/retrieve)                      |
| `PATCH`  | `/v1/dashboards/{id}`                    | [Update by ID](/api-reference/data-assets/dashboards/update)                      |
| `PATCH`  | `/v1/dashboards/name/{fqn}`              | [Update by name](/api-reference/data-assets/dashboards/update)                    |
| `DELETE` | `/v1/dashboards/{id}`                    | [Delete by ID](/api-reference/data-assets/dashboards/delete)                      |
| `DELETE` | `/v1/dashboards/name/{fqn}`              | [Delete by name](/api-reference/data-assets/dashboards/delete)                    |
| `PUT`    | `/v1/dashboards/restore`                 | [Restore soft-deleted dashboard](/api-reference/data-assets/dashboards/delete)    |
| `GET`    | `/v1/dashboards/{id}/versions`           | [List versions](/api-reference/data-assets/dashboards/versions)                   |
| `GET`    | `/v1/dashboards/{id}/versions/{version}` | [Get specific version](/api-reference/data-assets/dashboards/versions)            |
| `PUT`    | `/v1/dashboards/{id}/followers`          | [Add follower](/api-reference/data-assets/dashboards/followers-votes)             |
| `DELETE` | `/v1/dashboards/{id}/followers/{userId}` | [Remove follower](/api-reference/data-assets/dashboards/followers-votes)          |
| `PUT`    | `/v1/dashboards/{id}/vote`               | [Add/update vote](/api-reference/data-assets/dashboards/followers-votes)          |