Dashboard Bulk Action

Perform a bulk action on a list of dashboards.

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

Applies one action to a list of dashboards: delete or archive. The response summarizes how many were requested, succeeded, and failed, and gives a result for each ID.

When to use it

Use it to archive or clean up many dashboards in one call instead of sending one request per dashboard.

Required parameters

  • action (body): the action to perform on the dashboards.
  • ids (body): list of dashboard IDs to perform the action on.

Response

A successful call returns 200 OK with a BulkActionResponse: a summary with the requested, succeeded, and failed counts, and a results array with each ID, its status (success or failed), and any error code and message.

Related: Archive a dashboard, Delete a dashboard, List dashboards

Body Params
string
enum
required

The action to perform on the dashboards

Allowed:
ids
array of uuids
required
length between 1 and 50

List of dashboard IDs to perform the action on

Ids*
Responses

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