List monitor runs

Runs for this monitor, newest first.

Use type=production for live runs. Pass simulation_id to read one test. That also adds a simulation object so you can see whether the test is still running.

Set include_events to true to include the events. Otherwise events is empty. Live runs include only new events. A test also includes events that were not new, which helps you tune the monitor.

GET /v1/search-monitoring/monitors/{monitor_id}/runs

List monitor runs

cURL

curl --request GET \
  --url https://api.bigdata.com/v1/search-monitoring/monitors/{monitor_id}/runs \
  --header 'X-API-KEY: <api-key>'

200

production

{
  "results": [
    {
      "id": "6af74cb7-0a6e-4ea0-8421-acde4c85e56a",
      "status": "COMPLETED",
      "is_simulation": false,
      "simulation_id": null,
      "window_start": "2026-10-23T08:00:00Z",
      "window_end": "2026-10-23T09:00:00Z",
      "event_count": 1,
      "events": [],
      "usage": {
        "premium_news_tokens": 1200,
        "model_tokens": 800
      }
    }
  ],
  "pagination": {
    "has_cursor": false,
    "cursor": null
  },
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  }
}

Authorizations

X-API-KEY · string · header · required

API key from the Bigdata Developer Platform.

Path Parameters

monitor_id · string<uuid> · required

Id returned when you created the monitor.

Query Parameters

type · enum<string> · default: production

production for live runs, or simulation for tests. A simulation_id takes priority over this.

Available options: production, simulation

simulation_id · string<uuid>

Return the runs from one test. If the id is unknown, simulation is null.

status · enum<string>

Return only runs in this state: PENDING, COMPLETED, or FAILED. PENDING is still processing, COMPLETED is ready to review, and FAILED could not be completed.

Available options: PENDING, COMPLETED, FAILED

include_events · boolean · default: false

Set to true to include events. Otherwise each run's events array is empty.

limit · integer · default: 50

How many live runs to return. From 1 to 200. The default is 50. Test pages always return 50.

Required range: 1 <= x <= 200

cursor · string

Cursor from the previous page. Send the same filters with it.

Response

200

application/json

Runs returned.

results · object[] · required

Show child attributes

pagination · object · required

Show child attributes

metadata · object · required

Show child attributes

simulation · object | null

Included when you passed simulation_id. Null if that id is unknown. Omitted for a live run list.

Show child attributes