Orq.ai · Schema
ListAlertsResponse
Artificial IntelligencePlatformEnterpriseGovernanceSoftwareFactory
Properties
| Name | Type | Description |
|---|---|---|
| object | string | Object discriminator for list responses; always `list`. |
| data | array | Page of alerts, ordered newest first. |
| has_more | boolean | Whether more alerts are available in the selected pagination direction. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/orq/json-schema/orq-list-alerts-response-schema.json",
"title": "ListAlertsResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/orq-alerts-api-openapi.yml#/components/schemas/ListAlertsResponse",
"required": [
"object",
"data",
"has_more"
],
"type": "object",
"properties": {
"object": {
"type": "string",
"description": "Object discriminator for list responses; always `list`."
},
"data": {
"type": "array",
"items": {
"$ref": "#/$defs/Alert"
},
"description": "Page of alerts, ordered newest first."
},
"has_more": {
"type": "boolean",
"description": "Whether more alerts are available in the selected pagination\n direction."
}
},
"$defs": {
"Alert": {
"required": [
"alert_id",
"display_name",
"description",
"project_id",
"signal",
"query",
"condition",
"notifier_ids",
"enabled",
"status",
"created_at",
"updated_at",
"created_by_id",
"updated_by_id"
],
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"description": "Unique alert identifier assigned by ORQ, for example `alert_01H...`.\n Use this value in retrieve, update, and delete requests."
},
"display_name": {
"type": "string",
"description": "Workspace-unique display name."
},
"description": {
"type": "string",
"description": "Short human-readable summary of what the alert watches."
},
"project_id": {
"type": "string",
"description": "Project that owns the alert. Immutable after creation."
},
"signal": {
"enum": [
"cost",
"latency",
"errors",
"evals",
"custom"
],
"type": "string",
"description": "UI signal preset the alert was created from."
},
"query": {
"allOf": [
{
"$ref": "#/$defs/AlertQuery"
}
],
"description": "Metric query evaluated on each tick."
},
"condition": {
"allOf": [
{
"$ref": "#/$defs/AlertCondition"
}
],
"description": "Threshold condition applied to the query result."
},
"notifier_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Notifiers that receive trigger-open and trigger-resolve\n notifications."
},
"enabled": {
"type": "boolean",
"description": "Whether the alert is evaluated. Disabled alerts keep their trigger\n history but stop firing."
},
"status": {
"enum": [
"ok",
"degraded",
"triggered"
],
"type": "string",
"description": "Current runtime status, maintained by the evaluation engine."
},
"last_triggered_at": {
"type": [
"string",
"null"
],
"description": "Time when the alert last opened a trigger. `null` until the alert first triggers.",
"format": "date-time"
},
"recent_runs": {
"type": "array",
"items": {
"$ref": "#/$defs/AlertRun"
},
"description": "Rolling window of the most recent evaluation ticks, oldest first.\n Maintained by the evaluation engine; read-only."
},
"created_at": {
"type": "string",
"description": "Time when the alert was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "Time when the alert was last updated.",
"format": "date-time"
},
"created_by_id": {
"type": "string",
"description": "User ID that created the alert."
},
"updated_by_id": {
"type": "string",
"description": "User ID that last updated the alert."
},
"display": {
"description": "Display options for the alert activity chart. `null` when none are saved.",
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/AlertDisplay"
}
]
},
{
"type": "null"
}
]
}
}
},
"AlertCondition": {
"required": [
"comparator",
"threshold",
"window",
"interval"
],
"type": "object",
"properties": {
"comparator": {
"enum": [
"gt",
"gte",
"lt",
"lte",
"eq"
],
"type": "string",
"description": "Comparison applied as `value <comparator> threshold`."
},
"threshold": {
"type": "number",
"description": "Critical-tier threshold. Breaching it opens (or escalates) a\n trigger at critical severity.",
"format": "double"
},
"degraded_threshold": {
"type": "number",
"description": "Optional degraded-tier threshold. Values past it but short of\n `threshold` open a trigger at degraded severity. Must sit on the\n recovery side of `threshold` for the chosen comparator and is not\n supported with `eq`.",
"format": "double"
},
"resolve_threshold": {
"type": "number",
"description": "Optional custom resolve bound (hysteresis). An open trigger\n resolves only once the value recovers past this bound; defaults to\n the lowest configured tier. Must sit at or past that tier on the\n recovery side. Not supported with `eq`.",
"format": "double"
},
"window": {
"enum": [
"5m",
"15m",
"30m",
"1h",
"4h",
"1d"
],
"type": "string",
"description": "Look-back window aggregated on each evaluation tick."
},
"interval": {
"enum": [
"5m",
"15m",
"1h",
"1d"
],
"type": "string",
"description": "How often the alert is evaluated. Plan limits may enforce a minimum."
},
"delay": {
"enum": [
"30s",
"60s",
"120s",
"300s",
"600s"
],
"type": "string",
"description": "Ingestion delay subtracted from the evaluation window. Defaults to `30s`."
}
}
},
"AlertDisplay": {
"type": "object",
"properties": {
"visualization": {
"enum": [
"lines",
"bars"
],
"type": "string",
"description": "Chart style for the alert activity chart."
},
"preview_range": {
"enum": [
"1h",
"4h",
"1d",
"7d"
],
"type": "string",
"description": "Default time range for the alert activity chart."
}
}
},
"AlertQuery": {
"required": [
"metric"
],
"type": "object",
"properties": {
"metric": {
"type": "string",
"description": "Reporting API catalogue metric, e.g. `genai.cost` or\n `genai.latency.avg`. Validated against the catalogue when the alert\n is saved."
},
"filters": {
"type": "array",
"items": {
"$ref": "#/$defs/MonitorFilter"
},
"description": "Reporting filters combined with AND."
}
}
},
"AlertRun": {
"required": [
"at",
"value",
"breached",
"has_data"
],
"type": "object",
"properties": {
"at": {
"type": "string",
"description": "Time of the evaluation tick.",
"format": "date-time"
},
"value": {
"type": "number",
"description": "Observed metric value. Zero when `has_data` is false.",
"format": "double"
},
"breached": {
"type": "boolean",
"description": "Whether the value breached the alert condition."
},
"has_data": {
"type": "boolean",
"description": "Whether the evaluation window contained any data."
},
"severity": {
"enum": [
"critical",
"degraded"
],
"type": "string",
"description": "Tier the value landed in when breached. Empty when not breached."
}
}
},
"MonitorFilter": {
"required": [
"field",
"op",
"values"
],
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Reporting dimension to filter on. Valid fields depend on the\n metric; validated when the monitor is saved."
},
"op": {
"enum": [
"eq",
"neq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between",
"contains",
"exists",
"not_exists"
],
"type": "string",
"description": "Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Values compared against the selected field."
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/orq-list-alerts-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.