Dashboard

Get Dashboard

Returns aggregate statistics and daily timeseries data for the authenticated account's environment.

Statistics include function call counts broken down by type (as a dynamic map keyed by function type), error counts, correction counts, estimated extracted fields, and per-type latency statistics (avg, p50, p90, p99).

The timeseries provides daily granularity for volume, errors, and latency (all broken down by function type) over the selected period.

If no date range is specified, defaults to the last 90 days.

GET
/v2/dashboard
x-api-key<token>

Authenticate using API Key in request header

In: header

Query Parameters

from?string

Start of the date range in RFC 3339 format (e.g. 2025-01-01T00:00:00Z). Defaults to 90 days ago.

to?string

End of the date range in RFC 3339 format (e.g. 2025-03-31T23:59:59Z). Defaults to now.

Response Body

application/json

curl -X GET "https://api.bem.ai/v2/dashboard"
{
  "stats": {
    "functionCalls": 0,
    "callsByType": {},
    "errors": 0,
    "extractedFields": 0,
    "avgFieldsPerTransform": 0.1,
    "isFieldsEstimated": true,
    "corrections": 0,
    "latencyByType": {}
  },
  "timeseries": [
    {
      "day": "string",
      "callsByType": {},
      "errors": 0,
      "latencyByType": {}
    }
  ]
}