Docs/API reference / Dashboards
Read dashboards
Requires `developer_api.dashboards.read` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected.
The request panel saves credentials and API settings in this browser. Privacy details
Authorization
developerApiKey AuthorizationBearer <token>
Project-scoped Developer API connection key. Grant only the required operation permissions.
In: header
Path Parameters
project_id*string
Match
.*\S.*Length
1 <= length <= 128dashboard_id*string
Match
.*\S.*Length
1 <= length <= 128Query Parameters
include_archived?boolean
Include archived resources explicitly. Archived history still requires authorization.
Default
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
bash
curl -X GET "https://example.com/dev-api/v1/p/string/dashboards/string"json
{
"request_id": "string",
"data": {
"lifecycle_state": "active",
"archived_at": "2019-08-24T14:15:22Z",
"archived_by": {
"type": "user",
"id": "string"
},
"id": "string",
"name": "string",
"revision": 1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"widgets": [
{
"id": "stringstringstringstr",
"name": "string",
"widget_type": "graph",
"grid_x": 1,
"grid_y": 1,
"grid_width": 1,
"grid_height": 1
}
]
}
}