Query Ad-hoc Widget Data

curl -X POST https://api.confident-ai.com/v1/widgets/query \
     -H "Content-Type: application/json" \
     -d '{
  "widget": {
    "name": "Trace Count",
    "type": "LINE",
    "unit": "COUNT",
    "mode": "TIME_SERIES",
    "lines": [
      {
        "name": "Count",
        "dataModel": "TRACE",
        "aggregation": "COUNT"
      }
    ]
  },
  "startTime": "2024-01-01T00:00:00.000Z",
  "endTime": "2024-01-31T23:59:59.999Z",
  "granularity": "day"
}'

{
  "success": true,
  "data": {
    "kind": "TIME_SERIES",
    "type": "LINE",
    "mode": "TIME_SERIES",
    "unit": "COUNT",
    "xAxis": {
      "type": "time"
    },
    "series": [
      {
        "key": "Count",
        "name": "Count",
        "color": "BLUE",
        "points": [
          {
            "x": "2024-01-01T00:00:00.000Z",
            "y": 42
          }
        ],
        "lineId": "line-0"
      }
    ]
  },
  "deprecated": false
}

Computes widget data from a widget definition supplied inline, without creating a dashboard or saving a widget. Returns the same data shape as the dashboard widget query. Scoped to the project of the API key. At most 20 lines and a topK.limit of 100 are allowed, and an explicit query range may not exceed 366 days.

Request

Response