Help Center/ DataArts Insight/ API Reference/ Dashboard/ Batch Publishing Dashboards
Updated on 2025-02-25 GMT+08:00

Batch Publishing Dashboards

Function

This API is used to publish dashboards in batches.

URI

POST /v1/{project_id}/dashboards/batch-publish

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Workspace-Id

Yes

String

Workspace ID. For how to obtain it, see Obtaining a Workspace ID.

X-Auth-Token

Yes

String

User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

List of IDs of dashboards to be batch published.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

data

Boolean

Whether the request is successful. The options include true and false.

Example Request

Publish dashboards in batches.

https://{endpoint}/v1/{project_id}/dashboards/batch-publish
{
  "ids" : [ "009b3d3e-xxxx-4cc3-xxxx-dc54cd42xxxx" ]
}

Example Response

Status code: 200

Dashboards are successfully published in batches.

{
  "data" : true
}

Status Codes

Status Code

Description

200

Dashboards are successfully published in batches.

Error Codes

See Error Codes.