Update dashboard item by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates a dashboard item's name, query type, data source, data configuration, metadata, or visualization type, and returns the updated item.

When to use it

Use it to change what a widget shows or how it is drawn.

Required parameters

  • dashboard_item_id (path): the ID of the dashboard item.
  • name (body): the item name. The field must be present and can be null.

Optional body fields: query_type, datasource, data_config, item_metadata, visualization_type.

Response

A successful call returns 200 OK with the updated DashboardItem object.

Related: Get a dashboard item, Delete a dashboard item, Update a dashboard

Path Params
uuid
required
Body Params
required
length between 1 and 50
QueryType | null
Datasource | null
DataConfigGeneral | DataConfigDistributionCompare | null
object | null
VisualizationType | null
Responses

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json