> ## 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 monitors > View your monitors. Filter the list by status, name, or the development each monitor is designed to track. ## OpenAPI ````yaml /api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors 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: get: tags: - Monitors summary: List monitors description: >- View your monitors. Filter the list by status, name, or the development each monitor is designed to track. operationId: listMonitors parameters: - name: status in: query required: false description: Filter by monitor status. schema: anyOf: - $ref: '#/components/schemas/MonitorStatus' - type: 'null' example: active - name: name in: query required: false description: Filter by monitor name using a case-insensitive substring match. schema: anyOf: - type: string - type: 'null' example: M&A - name: intent in: query required: false description: Filter by monitor intent using a case-insensitive substring match. schema: anyOf: - type: string - type: 'null' example: rating downgrade - name: limit in: query required: false description: Maximum number of monitors to return. schema: type: integer default: 50 minimum: 1 responses: '200': description: Monitors returned. content: application/json: schema: $ref: '#/components/schemas/MonitorListResponse' examples: financeMonitors: summary: Finance monitoring library value: results: - id: 6af74cb7-0a6e-4ea0-8421-acde4c85e56a name: Credit Rating Downgrade or Negative Watch intent: >- Watch for rating downgrades and negative watch placements status: active created_at: '2026-08-26T09:30:00Z' - id: f44cfb70-08a8-46b7-95b9-acde63d228b4 name: M&A Activity Monitor intent: >- Track announced acquisitions and material deal-status changes status: active created_at: '2026-08-25T14:10:00Z' - id: 350393ec-8678-495c-804b-acde4eb32445 name: Central Bank Policy Rate Decisions & Forward Guidance intent: >- Track policy rate decisions and changes in forward guidance status: inactive created_at: '2026-08-25T11:45:00Z' pagination: has_cursor: false metadata: request_id: req_01J6C69Y4D5J7M2P47X1N9V5C8 timestamp: '2026-08-28T08:12:15Z' '422': $ref: '#/components/responses/ValidationError' components: schemas: MonitorStatus: type: string enum: - active - inactive description: >- `active` runs on schedule. `inactive` keeps its configuration but does not start new scheduled runs. MonitorListResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/Monitor' pagination: $ref: '#/components/schemas/Pagination' metadata: $ref: '#/components/schemas/Metadata' required: - results - pagination - metadata Monitor: allOf: - $ref: '#/components/schemas/MonitorCreate' - type: object properties: id: type: string format: uuid created_at: type: string format: date-time required: - id - created_at 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' MonitorCreate: type: object properties: name: type: string description: Short, recognizable monitor name. intent: type: string description: Plain-language description of what should count as an event. status: $ref: '#/components/schemas/MonitorStatus' default: inactive search_queries: $ref: '#/components/schemas/SearchQueries' schedule: $ref: '#/components/schemas/Schedule' structured_output: $ref: '#/components/schemas/StructuredOutput' extraction_instructions: type: string description: >- Rules explaining what to include, what to exclude, and how to interpret matching content. entity_watchlist: type: array description: Optional set of entities the monitor should track. items: $ref: '#/components/schemas/EntityWatchlistItem' required: - intent - schedule 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 SearchQueries: type: object description: >- What to search for during each run. Set the search mode and provide the same query object used by [Search documents](/api-reference/search/search-documents#body-query). properties: search_mode: type: string enum: - fast - smart default: fast query: type: object description: >- The [Search documents query object](/api-reference/search/search-documents#body-query), including its search text, filters, external search, chunk limit, and ranking settings. additionalProperties: true required: - search_mode - query additionalProperties: false Schedule: type: object description: How often an active monitor searches for new content. properties: frequency: type: string description: Time between scheduled runs, such as `1h` or `4h`. examples: - 1h - 4h required: - frequency StructuredOutput: type: object description: >- The fields returned with every event. Each property name becomes a field in the response. additionalProperties: $ref: '#/components/schemas/StructuredOutputField' EntityWatchlistItem: type: object description: A company or other Bigdata entity the monitor should track. properties: name: type: string description: Canonical entity name. rp_entity_id: type: string description: Bigdata knowledge graph entity ID. required: - name - rp_entity_id additionalProperties: true StructuredOutputField: type: object description: One field to extract for every event. properties: description: type: string description: Instructions explaining what information belongs in this field. field_type: type: string enum: - text - number - enum - entity_reference values: type: array description: Allowed values when `field_type` is `enum`. items: type: string required: - field_type 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. ````