/api/dashboard endpoints.
/api/dashboard endpoints.
(add-query-average-durations dashboard)Add a average_execution_time field to each card (and series) belonging to dashboard.
Add a `average_execution_time` field to each card (and series) belonging to `dashboard`.
DELETE /api/dashboard/:dashboard-id/public_linkDelete the publicly-accessible link to this Dashboard.
You must be a superuser to do this.
dashboard-id## `DELETE /api/dashboard/:dashboard-id/public_link` Delete the publicly-accessible link to this Dashboard. You must be a superuser to do this. ##### PARAMS: * **`dashboard-id`**
## `DELETE /api/dashboard/:id` Delete a Dashboard. ##### PARAMS: * **`id`**
DELETE /api/dashboard/:id/cardsRemove a DashboardCard from a Dashboard.
id
dashcardId value must be a valid integer greater than zero.
## `DELETE /api/dashboard/:id/cards` Remove a `DashboardCard` from a Dashboard. ##### PARAMS: * **`id`** * **`dashcardId`** value must be a valid integer greater than zero.
## `DELETE /api/dashboard/:id/favorite` Unfavorite a Dashboard. ##### PARAMS: * **`id`**
GET /api/dashboard/Get Dashboards. With filter option f (default all), restrict results as follows:
all - Return all Dashboards.mine - Return Dashboards created by the current user.archived - Return Dashboards that have been archived. (By default, these are excluded.)f value may be nil, or if non-nil, value must be one of: all, archived, mine.## `GET /api/dashboard/` Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows: * `all` - Return all Dashboards. * `mine` - Return Dashboards created by the current user. * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.) ##### PARAMS: * **`f`** value may be nil, or if non-nil, value must be one of: `all`, `archived`, `mine`.
## `GET /api/dashboard/:id` Get Dashboard with ID. ##### PARAMS: * **`id`**
## `GET /api/dashboard/:id/related` Return related entities. ##### PARAMS: * **`id`**
## `GET /api/dashboard/:id/revisions` Fetch `Revisions` for Dashboard with ID. ##### PARAMS: * **`id`**
GET /api/dashboard/embeddableFetch a list of Dashboards where enable_embedding is true. The dashboards can be embedded using the embedding
endpoints and a signed JWT.
You must be a superuser to do this.
## `GET /api/dashboard/embeddable` Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding endpoints and a signed JWT. You must be a superuser to do this.
GET /api/dashboard/publicFetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible if public sharing is enabled.
You must be a superuser to do this.
## `GET /api/dashboard/public` Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is enabled. You must be a superuser to do this.
POST /api/dashboard/Create a new Dashboard.
name value must be a non-blank string.
description value may be nil, or if non-nil, value must be a string.
parameters value must be an array. Each value must be a map.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
collection_position value may be nil, or if non-nil, value must be an integer greater than zero.
dashboard
## `POST /api/dashboard/` Create a new Dashboard. ##### PARAMS: * **`name`** value must be a non-blank string. * **`description`** value may be nil, or if non-nil, value must be a string. * **`parameters`** value must be an array. Each value must be a map. * **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`dashboard`**
POST /api/dashboard/:dashboard-id/public_linkGenerate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public sharing must be enabled.
You must be a superuser to do this.
dashboard-id## `POST /api/dashboard/:dashboard-id/public_link` Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public sharing must be enabled. You must be a superuser to do this. ##### PARAMS: * **`dashboard-id`**
POST /api/dashboard/:from-dashboard-id/copyCopy a Dashboard.
from-dashboard-id
name value may be nil, or if non-nil, value must be a non-blank string.
description value may be nil, or if non-nil, value must be a string.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
collection_position value may be nil, or if non-nil, value must be an integer greater than zero.
dashboard
## `POST /api/dashboard/:from-dashboard-id/copy` Copy a Dashboard. ##### PARAMS: * **`from-dashboard-id`** * **`name`** value may be nil, or if non-nil, value must be a non-blank string. * **`description`** value may be nil, or if non-nil, value must be a string. * **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`dashboard`**
POST /api/dashboard/:id/cardsAdd a Card to a Dashboard.
id
cardId value may be nil, or if non-nil, value must be an integer greater than zero.
parameter_mappings value must be an array. Each value must be a map.
series
dashboard-card
## `POST /api/dashboard/:id/cards` Add a `Card` to a Dashboard. ##### PARAMS: * **`id`** * **`cardId`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`parameter_mappings`** value must be an array. Each value must be a map. * **`series`** * **`dashboard-card`**
## `POST /api/dashboard/:id/favorite` Favorite a Dashboard. ##### PARAMS: * **`id`**
POST /api/dashboard/:id/revertRevert a Dashboard to a prior Revision.
id
revision_id value must be an integer greater than zero.
## `POST /api/dashboard/:id/revert` Revert a Dashboard to a prior `Revision`. ##### PARAMS: * **`id`** * **`revision_id`** value must be an integer greater than zero.
## `POST /api/dashboard/save` Save a denormalized description of dashboard. ##### PARAMS: * **`dashboard`**
POST /api/dashboard/save/collection/:parent-collection-idSave a denormalized description of dashboard into collection with ID :parent-collection-id.
parent-collection-id
dashboard
## `POST /api/dashboard/save/collection/:parent-collection-id` Save a denormalized description of dashboard into collection with ID `:parent-collection-id`. ##### PARAMS: * **`parent-collection-id`** * **`dashboard`**
PUT /api/dashboard/:idUpdate a Dashboard.
Usually, you just need write permissions for this Dashboard to do this (which means you have appropriate
permissions for the Cards belonging to this Dashboard), but to change the value of enable_embedding you must be a
superuser.
parameters value may be nil, or if non-nil, value must be an array. Each value must be a map.
points_of_interest value may be nil, or if non-nil, value must be a string.
description value may be nil, or if non-nil, value must be a string.
archived value may be nil, or if non-nil, value must be a boolean.
collection_position value may be nil, or if non-nil, value must be an integer greater than zero.
show_in_getting_started value may be nil, or if non-nil, value must be a boolean.
enable_embedding value may be nil, or if non-nil, value must be a boolean.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
dash-updates
name value may be nil, or if non-nil, value must be a non-blank string.
caveats value may be nil, or if non-nil, value must be a string.
embedding_params value may be nil, or if non-nil, value must be a valid embedding params map.
id
position value may be nil, or if non-nil, value must be an integer greater than zero.
## `PUT /api/dashboard/:id` Update a Dashboard. Usually, you just need write permissions for this Dashboard to do this (which means you have appropriate permissions for the Cards belonging to this Dashboard), but to change the value of `enable_embedding` you must be a superuser. ##### PARAMS: * **`parameters`** value may be nil, or if non-nil, value must be an array. Each value must be a map. * **`points_of_interest`** value may be nil, or if non-nil, value must be a string. * **`description`** value may be nil, or if non-nil, value must be a string. * **`archived`** value may be nil, or if non-nil, value must be a boolean. * **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`show_in_getting_started`** value may be nil, or if non-nil, value must be a boolean. * **`enable_embedding`** value may be nil, or if non-nil, value must be a boolean. * **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero. * **`dash-updates`** * **`name`** value may be nil, or if non-nil, value must be a non-blank string. * **`caveats`** value may be nil, or if non-nil, value must be a string. * **`embedding_params`** value may be nil, or if non-nil, value must be a valid embedding params map. * **`id`** * **`position`** value may be nil, or if non-nil, value must be an integer greater than zero.
PUT /api/dashboard/:id/cardsUpdate Cards on a Dashboard. Request body should have the form:
{:cards [{:id ...
:sizeX ...
:sizeY ...
:row ...
:col ...
:series [{:id 123
...}]} ...]}
id
cards
## `PUT /api/dashboard/:id/cards`
Update `Cards` on a Dashboard. Request body should have the form:
{:cards [{:id ...
:sizeX ...
:sizeY ...
:row ...
:col ...
:series [{:id 123
...}]} ...]}
##### PARAMS:
* **`id`**
* **`cards`** Ring routes for api/dashboard: (POST_save_collection_:parent-collection-id POST_ PUT_:id DELETE_:dashboard-id_public_link GET_public GET_:id_revisions POST_:id_favorite GET_embeddable POST_:id_revert DELETE_:id_cards DELETE_:id_favorite GET_ POST_save POST_:id_cards POST_:from-dashboard-id_copy GET_:id_related POST_:dashboard-id_public_link DELETE_:id GET_:id PUT_:id_cards)
Ring routes for api/dashboard: (POST_save_collection_:parent-collection-id POST_ PUT_:id DELETE_:dashboard-id_public_link GET_public GET_:id_revisions POST_:id_favorite GET_embeddable POST_:id_revert DELETE_:id_cards DELETE_:id_favorite GET_ POST_save POST_:id_cards POST_:from-dashboard-id_copy GET_:id_related POST_:dashboard-id_public_link DELETE_:id GET_:id PUT_:id_cards)
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |