Retrieve all Dashboard IDs within a Collection
Purpose
This API allows users to retrieve all Dashboard IDs from a given Collection.
Method & HTTP Target Resource
GET /api/public/dashboard
Request Headers
The following request headers have to be provided with every request:
| Header | Constraints | Value |
|---|---|---|
| Authorization | REQUIRED | See Authorization. |
Query Parameters
The following query parameters have to be provided with every request:
| Parameter | Constraints | Value |
|---|---|---|
| collectionId | REQUIRED | The ID of the Collection for which to retrieve the Dashboard IDs. |
Request Body
No request body is required.
Result
The response contains a list of IDs of the Dashboards existing in the Collection with the given Collection ID.
Response Codes
Possible HTTP Response Status codes:
| Code | Description |
|---|---|
| 200 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See Authorization for more information. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |
Example
Retrieve all Dashboard IDs from a Collection
Assuming you want to retrieve all Dashboard IDs in the Collection with the ID 1234 and have configured the accessToken mySecret, this is what it would look like:
GET /api/public/dashboard?collectionId=1234
Request header
Authorization: Bearer mySecret
Response
Status 200.
Response Content
[
{
"id": "9b0eb845-e8ed-4824-bd85-8cd69038f2f5"
},
{
"id": "1a866c7c-563e-4f6b-adf1-c4648531f7d4"
}
]