# Clarity Dashboards API

**Canonical:** https://apis.io/apis/onclarity-com/onclarity-com-dashboards-api/  
**Provider:** Clarity — https://apis.io/providers/onclarity-com/  
**Base URL:** https://api.onclarity.com  
**Documentation:** https://api.onclarity.com

Clarity Dashboards API is one of 101 APIs that [Clarity](https://apis.io/providers/onclarity-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include dashboards. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The dashboards API from Clarity — 23 operation(s) for dashboards.

## Operations (30)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/dashboards/export/{dashboard_id}` | Export Dashboard |
| GET | `/api/v1/dashboards` | List Dashboards |
| POST | `/api/v1/dashboards` | Add Dashboard |
| GET | `/api/v1/dashboards/overview` | Get My Overview |
| PUT | `/api/v1/dashboards/overview` | Save My Overview |
| DELETE | `/api/v1/dashboards/overview` | Reset My Overview |
| GET | `/api/v1/dashboards/{dashboard_id}` | Get Dashboard Info |
| PUT | `/api/v1/dashboards/{dashboard_id}` | Update Dashboard |
| DELETE | `/api/v1/dashboards/{dashboard_id}` | Delete Dashboard |
| POST | `/api/v1/dashboards/create_from_topic` | Create Dashboard From Topic |
| POST | `/api/v1/dashboards/create_release_dashboard` | Create Release Dashboard |
| POST | `/api/v1/dashboards/create_release_dashboard_v2` | Create Release Dashboard V2 |
| POST | `/api/v1/dashboards/create_report_from_query` | Create Report From Query |
| PATCH | `/api/v1/dashboards/{dashboard_id}/tv-config` | Update Dashboard Tv Config |
| PATCH | `/api/v1/dashboards/{dashboard_id}/tv-link` | Update Dashboard Tv Link |
| POST | `/api/v1/dashboards/{dashboard_id}/tv-publish` | Publish Tv Dashboard |
| DELETE | `/api/v1/dashboards/{dashboard_id}/tv-draft` | Discard Tv Dashboard Draft |
| POST | `/api/v1/dashboards/{dashboard_id}/tv-rollback` | Rollback Tv Dashboard |
| GET | `/api/v1/dashboards/{dashboard_id}/tv-derived` | Get Derived Tv Dashboard |
| GET | `/api/v1/dashboards/tv/{key}` | Get Dashboard For Tv |
| GET | `/api/v1/dashboards/tv-resolve/{slug}` | Resolve Tv Slug |
| POST | `/api/v1/dashboards/multiple` | Update Multiple Dashboards |
| POST | `/api/v1/dashboards/{dashboard_id}/{element_key}` | Add Dashboard Element |
| PUT | `/api/v1/dashboards/{dashboard_id}/{element_key}` | Update Dashboard Element |
| DELETE | `/api/v1/dashboards/{dashboard_id}/{element_key}` | Delete Dashboard Element |
| PATCH | `/api/v1/dashboards/{dashboard_id}/batch` | Batch Update Dashboard |
| POST | `/api/v1/dashboards/chart` | Get Chart |
| POST | `/api/v1/dashboards/dashboard-plan` | Get Dashboard Plan |
| POST | `/api/v1/dashboards/chart-types` | Get Chart Types |
| POST | `/api/v1/dashboards/dashboard-with-ai` | Get Dashboard Plan |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-dashboards-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-dashboard-element-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-build-table-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-deeper-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-agent-response-schema.json

## Other Clarity APIs (12)

- [Clarity Accounts API](https://apis.io/apis/onclarity-com/onclarity-com-accounts-api/)
- [Clarity Admin API](https://apis.io/apis/onclarity-com/onclarity-com-admin-api/)
- [Clarity Agent Costs API](https://apis.io/apis/onclarity-com/onclarity-com-agent-costs-api/)
- [Clarity Agent Qa API](https://apis.io/apis/onclarity-com/onclarity-com-agent-qa-api/)
- [Clarity Agent Store Admin API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-admin-api/)
- [Clarity Agent Store API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-api/)
- [Clarity Agent Usage API](https://apis.io/apis/onclarity-com/onclarity-com-agent-usage-api/)
- [Clarity Anecdote Surveys API](https://apis.io/apis/onclarity-com/onclarity-com-anecdote-surveys-api/)
- [Clarity Anomalies API](https://apis.io/apis/onclarity-com/onclarity-com-anomalies-api/)
- [Clarity Asana API](https://apis.io/apis/onclarity-com/onclarity-com-asana-api/)
- [Clarity Bugs API](https://apis.io/apis/onclarity-com/onclarity-com-bugs-api/)
- [Clarity Classifications Admin API](https://apis.io/apis/onclarity-com/onclarity-com-classifications-admin-api/)

## Tags

dashboards

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/onclarity-com/onclarity-com-dashboards-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/onclarity-com/.