APIDashboards
Render a dashboard
Run a saved dashboard's queries over one time window and return its layout with one outcome per requested component (ok, empty, rejected, or error). Omit timeRange for the dashboard's default window, revision for the current one, and componentIds for every bound component.
POST https://api.sazabi.com/v1/dashboards/{id}/render
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08/render" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "revision": -9007199254740991, "definitionHash": "string", "title": "string", "description": "string", "resolvedTimeRange": { "kind": "absolute", "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "document": { "version": 1, "root": { "type": "root", "children": [ { "type": "text", "value": "string" } ] }, "componentNames": [ "string" ], "limits": { "maxSourceLength": -9007199254740991, "maxNodeCount": -9007199254740991, "maxComponentCount": 0, "maxTableRows": 0, "maxChartPoints": 0, "maxPropPayloadSize": -9007199254740991, "maxComponentDepth": -9007199254740991, "maxCodeBlockLength": -9007199254740991, "maxTextLength": -9007199254740991 } }, "requestedComponentIds": [ "string" ], "artifacts": { "property1": { "status": "ok", "data": { "version": 2, "type": "area_chart", "data": { "series": [ { "name": "string", "tone": "neutral", "points": [ { "x": null, "y": null } ] } ] }, "view": { "title": "string", "unit": "string", "stacked": true } }, "execution": { "spec": { "version": 2, "predicate": { "op": "and", "children": [ { "op": "and", "children": [] } ] }, "dimensions": [ { "kind": "service" } ], "measure": { "op": "count" }, "bucket": "1m", "output": "series", "series": { "limit": -9007199254740991, "overflow": "other" }, "order": { "by": "value", "direction": "asc" }, "times": true }, "resolvedTimeRange": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "meta": { "coverage": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "status": "complete", "reason": "stored_range" }, "freshness": { "watermark": "2019-08-24T14:15:22Z", "openBucketFrom": "2019-08-24T14:15:22Z" } }, "took": 0, "executionMs": 0 } }, "property2": { "status": "ok", "data": { "version": 2, "type": "area_chart", "data": { "series": [ { "name": "string", "tone": "neutral", "points": [ { "x": null, "y": null } ] } ] }, "view": { "title": "string", "unit": "string", "stacked": true } }, "execution": { "spec": { "version": 2, "predicate": { "op": "and", "children": [ { "op": "and", "children": [] } ] }, "dimensions": [ { "kind": "service" } ], "measure": { "op": "count" }, "bucket": "1m", "output": "series", "series": { "limit": -9007199254740991, "overflow": "other" }, "order": { "by": "value", "direction": "asc" }, "times": true }, "resolvedTimeRange": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "meta": { "coverage": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "status": "complete", "reason": "stored_range" }, "freshness": { "watermark": "2019-08-24T14:15:22Z", "openBucketFrom": "2019-08-24T14:15:22Z" } }, "took": 0, "executionMs": 0 } } }, "components": [ { "component": "string", "componentId": "string", "title": "string", "source": "live_query", "status": "ok", "points": 0 } ]}