> ## Documentation Index > Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt > Use this file to discover all available pages before exploring further. # List monitor runs > View completed, pending, or failed runs for a monitor. Choose live or simulation runs. Set `include_events=true` to include the events found during each run. ## OpenAPI ````yaml /api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors/{monitor_id}/runs openapi: 3.1.0 info: title: Monitors API description: >- Coming soon. Run a saved Bigdata Search on a schedule and receive structured events from new content. Test a monitor against recent historical data before turning it on. version: 1.0.0 servers: - url: https://api.bigdata.com description: Production server security: - API Key Authentication: [] tags: - name: Monitors description: Coming soon. Create, test, activate, and review monitors. paths: /v1/search-monitoring/monitors/{monitor_id}/runs: get: tags: - Monitors summary: List monitor runs description: >- View completed, pending, or failed runs for a monitor. Choose live or simulation runs. Set `include_events=true` to include the events found during each run. operationId: listMonitorRuns parameters: - $ref: '#/components/parameters/MonitorId' - name: type in: query required: false description: >- Return runs from the active monitor (`production`) or a historical test (`simulation`). schema: type: string enum: - production - simulation default: production - name: simulation_id in: query required: false description: Return runs from one historical test. Use with `type=simulation`. schema: anyOf: - type: string - type: 'null' example: sim_01J6C6J8VF7K8A4D7M2H5N9R3P - name: status in: query required: false description: Filter by run status. schema: anyOf: - $ref: '#/components/schemas/RunStatus' - type: 'null' - name: include_events in: query required: false description: Include the structured events found during each run. schema: type: boolean default: false example: true - name: limit in: query required: false description: >- Maximum number of live runs to return. This setting does not affect simulation runs. schema: type: integer default: 50 minimum: 1 responses: '200': description: Runs returned. content: application/json: schema: $ref: '#/components/schemas/RunListResponse' examples: completedSimulation: summary: Completed central bank simulation value: results: - id: run_01J6C72NV6A58H25PHX61DRE3G status: COMPLETED is_simulation: true simulation_id: sim_01J6C6J8VF7K8A4D7M2H5N9R3P window_start: '2026-08-27T08:00:00Z' window_end: '2026-08-27T12:00:00Z' event_count: 1 events: - id: evt_01J6C75H9JH9R5Y40MP8S6DKN2 summary: >- The central bank held its policy rate unchanged and signaled that future decisions will remain data-dependent. central_bank: Example Central Bank decision: hold grounding: - id: A97B4203751F headline: Central bank holds policy rate source: id: 5E6268 name: Example Financial News url: https://example.com/central-bank-rate-decision cnum: 2 timestamp: '2026-08-27T10:30:00Z' usage: api_query_units: 1 pagination: has_cursor: false metadata: request_id: req_01J6C77FKQY3HMR9K3VX60B4Y4 timestamp: '2026-08-28T08:12:15Z' '422': $ref: '#/components/responses/ValidationError' components: parameters: MonitorId: name: monitor_id in: path required: true description: Unique identifier for the monitor. schema: type: string format: uuid example: 6af74cb7-0a6e-4ea0-8421-acde4c85e56a schemas: RunStatus: type: string enum: - PENDING - COMPLETED - FAILED description: >- `PENDING` is still processing, `COMPLETED` is ready to review, and `FAILED` could not be completed. RunListResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/Run' pagination: $ref: '#/components/schemas/Pagination' metadata: $ref: '#/components/schemas/Metadata' required: - results - pagination - metadata Run: type: object properties: id: type: string status: $ref: '#/components/schemas/RunStatus' is_simulation: type: boolean simulation_id: anyOf: - type: string - type: 'null' window_start: type: string format: date-time window_end: type: string format: date-time event_count: type: integer minimum: 0 events: type: array items: $ref: '#/components/schemas/MonitorEvent' usage: $ref: '#/components/schemas/Usage' required: - id - status - is_simulation - window_start - window_end - event_count - events - usage Pagination: type: object properties: has_cursor: type: boolean description: Whether another page of results is available. required: - has_cursor Metadata: type: object properties: request_id: type: string timestamp: type: string format: date-time required: - request_id - timestamp HTTPValidationError: type: object properties: detail: type: array items: $ref: '#/components/schemas/ValidationError' MonitorEvent: type: object description: >- A structured event found during a run. The API returns it in the `events` array. Fields from `structured_output` appear alongside the summary and supporting sources. properties: id: type: string summary: type: string grounding: type: array items: $ref: '#/components/schemas/Grounding' required: - id - summary - grounding additionalProperties: true Usage: type: object properties: api_query_units: type: number required: - api_query_units ValidationError: type: object properties: loc: type: array items: anyOf: - type: string - type: integer msg: type: string type: type: string input: {} ctx: type: object additionalProperties: true required: - loc - msg - type Grounding: type: object properties: id: type: string headline: type: string source: $ref: '#/components/schemas/GroundingSource' url: type: string format: uri cnum: type: integer timestamp: type: string required: - id - headline - source - url - cnum - timestamp GroundingSource: type: object properties: id: type: string name: type: string required: - id - name responses: ValidationError: description: Validation error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' securitySchemes: API Key Authentication: type: apiKey in: header name: X-API-KEY description: API key created in the Bigdata Developer Platform. ````