> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/api-reference/platform-apis/dashboards.md).

# Dashboards

Read, organize, and download Harness dashboards with the Harness Dashboards API.

The Dashboards API works with Harness custom dashboards. Use it to read dashboards and their folders, and to download dashboard data.

## Request basics

* **API key token**: Send it in the `x-api-key` header on every request. Go to [Manage API keys](https://developer.harness.io/harness-platform/use-harness-platform/automation/api/add-and-manage-api-keys) to create a key and token.
* **Account ID**: Most endpoints take your account ID as the `accountId` query parameter.
* **Base URL**: Send requests to `https://app.harness.io/dashboard`, followed by the endpoint path.

## Example request

Read one dashboard. The dashboard ID is the number at the end of the dashboard's URL in Harness:

```bash
curl "https://app.harness.io/dashboard/dashboards/DASHBOARD_ID?accountId=ACCOUNT_ID" \
  -H "x-api-key: $HARNESS_API_KEY"
```

Replace `ACCOUNT_ID` and `DASHBOARD_ID` with your own values, and set `HARNESS_API_KEY` to your API key token.

## Find an endpoint

Endpoint paths are relative to the base URL.

* **Dashboards**: Custom views of data across your Harness modules, built from tiles and filters. Read a dashboard with `GET /dashboards/{dashboard_id}` and its tiles with `GET /dashboards/{dashboard_id}/elements`. Go to [Harness Dashboards](https://developer.harness.io/harness-platform/use-harness-platform/harness-dashboards) to build a dashboard.
* **Folders**: Containers that group dashboards and control who can see them. Read a folder with `GET /folders/{folder_id}` and create one with `POST /folders`. Go to [Manage dashboards](https://developer.harness.io/harness-platform/use-harness-platform/platform-access-control/manage-dashboards) to manage dashboard access.
* **Downloads**: Exports of a dashboard's data for use outside Harness. Download a dashboard as CSV with `GET /download/dashboards/{dashboard_id}/csv`, or as PDF with `GET /download/dashboards/{dashboard_id}/pdf`.
