axonpush
API referenceDashboards

POST /dashboards

Author a dashboard tailored to this org's business. Discover which custom dimensions exist via /analytics/dimensions, then define widgets that bind to /analytics/breakdown (dimension=tag&tagKey=<key>), /analytics/timeseries, and /analytics/latency, optionally scoped by filterTagKey+filterTagValue.

POST
/dashboards

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

curl -X POST "https://example.com/dashboards" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "spec": {      "widgets": [        {          "type": "kpi"        }      ]    }  }'
{  "$schema": "https://example.com/schemas/DashboardView.json",  "createdAt": "string",  "createdBy": "string",  "dashboardId": "string",  "description": "string",  "name": "string",  "spec": {    "widgets": [      {        "dimension": "string",        "limit": 0,        "metric": "string",        "scope": {          "app": "string",          "channel": "string",          "environment": "string",          "filterTagKey": "string",          "filterTagValue": "string",          "model": "string",          "provider": "string",          "source": "string"        },        "tagKey": "string",        "title": "string",        "type": "kpi"      }    ]  },  "updatedAt": "string"}