Docs/API reference / Dashboard widgets
Data dashboard widgets
Requires `developer_api.dashboard_widget_data.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. Returns data for graph, scatter plot, or table widgets. Markdown widgets return widget_has_no_data. Keep the saved widget revision unchanged across cursor pages.
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 <= 128^[A-Za-z0-9_-]{21}$21 <= length <= 21Query Parameters
Start of the requested time range (inclusive). Must be earlier than to.
date-timeEnd of the requested time range (exclusive).
date-timeInclude archived resources explicitly. Archived history still requires authorization.
falseMaximum entries to return. Defaults shown are repository defaults; deployed limits may differ.
1 <= value <= 50001000Opaque 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/stringstringstringstr/data?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"{
"request_id": "string",
"data": {
"dashboard_id": "string",
"widget_id": "stringstringstringstr",
"widget_type": "graph",
"revision": 1,
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"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"
}
}
]
},
"series": [
{
"series_id": "stringstringstringstr",
"source": {
"instrument_id": "string",
"instrument_name": "string",
"instrument_lifecycle_state": "active",
"variable_id": "string",
"variable_name": "string",
"variable_alias": "string",
"variable_type": "",
"variable_lifecycle_state": "active",
"value_type": "",
"unit": "cm",
"unavailable_reason": "string",
"available": false
},
"raw_points": [
{
"entry_id": "stringstringstringstr",
"instrument_timestamp": "2019-08-24T14:15:22Z",
"value": 0,
"quality": "pass",
"nil_reason": "string",
"status": "raw"
}
],
"aggregation_points": [
{
"entry_id": "stringstringstringstr",
"display_timestamp": "2019-08-24T14:15:22Z",
"window_start": "2019-08-24T14:15:22Z",
"window_end": "2019-08-24T14:15:22Z",
"value": 0,
"quality": "pass",
"sample_count": 0,
"rejected_count": 0
}
]
}
]
},
"next_cursor": "string"
}