Monitors

Returns the monitors visible to the caller, newest first. A human filtering by project sees that project's monitors plus workspace-wide monitors. A project-scoped API key sees only monitors in its strict project scope. Use starting_after or ending_before to page.

get/v2/monitors

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/monitors
  • Auth
    HTTP bearer

Query parameters

limitinteger

Page size, 1-200. Unset uses the server default (25).

starting_afterstring

Cursor for forward pagination. Set to the monitor_id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the monitor_id of the first item from the previous page.

project_idstring

Restrict results to one project. Human callers also see workspace-wide monitors; a project-scoped API key sees only its strict project scope.

searchstring

Case-insensitive substring match on display name and description.

workspace_wideboolean

Restrict results by scope. Set true for workspace-wide monitors only, false for project-scoped monitors only; omit to return both.

Response

OK

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more monitors are available in the selected pagination direction.

Changes