Docs/API reference / Dashboard widgets
List dashboard widgets
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 Project-scoped Developer API connection key. Grant only the required operation permissions.
In: header
Path Parameters
.*\S.*1 <= length <= 128.*\S.*1 <= length <= 128Query Parameters
Include archived resources explicitly. Archived history still requires authorization.
falseMaximum entries to return. Defaults shown are repository defaults; deployed limits may differ.
1 <= value <= 10050Opaque cursor from next_cursor. Keep all filters, resource scope, time range, order, and authorization context unchanged.
1 <= length <= 16384Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/dev-api/v1/p/string/dashboards/string/widgets"{
"request_id": "string",
"data": [
{
"id": "stringstringstringstr",
"name": "string",
"grid_x": 1,
"grid_y": 1,
"grid_width": 1,
"grid_height": 1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"widget_type": "graph",
"configuration": {
"show_legend": true,
"series": [
{
"id": "stringstringstringstr",
"instrument_id": "string",
"variable_id": "string",
"alias": "string",
"graph_type": "line",
"color": "blue",
"style": "solid",
"weight": "thin",
"marker": "none",
"y_axis": "left",
"connect_nulls": true,
"rounding": {
"mode": "exact",
"decimal_places": null
},
"aggregation": {
"aggregation_operation": "sum",
"rolling": true,
"aggregation_interval": "hour"
}
}
]
}
}
],
"next_cursor": "string"
}