{ "openapi": "3.0.1", "info": { "title": "API Endpoint Health & JSON Schema Drift Monitor", "description": "Monitor public JSON APIs for downtime, latency, missing fields, and response-shape changes. Scheduled checks produce structured alerts for developers, data pipelines, and AI agents.", "version": "0.0", "x-build-id": "K2kaB01KR5ZdXWsQa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rustic_soybean~api-endpoint-contract-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rustic_soybean-api-endpoint-contract-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/rustic_soybean~api-endpoint-contract-monitor/runs": { "post": { "operationId": "runs-sync-rustic_soybean-api-endpoint-contract-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/rustic_soybean~api-endpoint-contract-monitor/run-sync": { "post": { "operationId": "run-sync-rustic_soybean-api-endpoint-contract-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "endpoints" ], "properties": { "endpoints": { "title": "Public API endpoints to monitor", "minItems": 1, "maxItems": 20, "type": "array", "description": "1-20 public HTTP/HTTPS API URLs. No authentication or private network endpoints.", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Endpoint name", "description": "Short unique label for this API endpoint." }, "url": { "type": "string", "title": "Public API URL", "description": "Public unauthenticated HTTP or HTTPS endpoint URL to check." }, "expectedStatus": { "type": "integer", "title": "Expected HTTP status", "default": 200, "description": "HTTP status code that should be returned when the endpoint is healthy." }, "requiredJsonPaths": { "type": "array", "title": "Required JSON paths", "items": { "type": "string" }, "description": "Optional JSON paths that must exist, for example data.items or results[0].id." } }, "required": [ "name", "url" ] } }, "monitorKey": { "title": "Monitor state name", "type": "string", "description": "Stable watchlist name used to persist the comparison baseline between scheduled runs.", "default": "default" }, "checkJson": { "title": "Require valid JSON", "type": "boolean", "description": "Require the response to parse as JSON before the endpoint can be healthy.", "default": true }, "emitOnlyChanges": { "title": "Only output new/changed events", "type": "boolean", "description": "When enabled, unchanged checks update the baseline but do not write paid dataset rows.", "default": false }, "latencyWarnMs": { "title": "Slow response threshold (ms)", "minimum": 100, "maximum": 30000, "type": "integer", "description": "Mark the endpoint unhealthy when response latency exceeds this threshold.", "default": 3000 }, "timeoutMs": { "title": "Timeout per endpoint (ms)", "minimum": 1000, "maximum": 15000, "type": "integer", "description": "Maximum time to wait for each endpoint request before recording a failure.", "default": 8000 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 1024, "maximum": 500000, "type": "integer", "description": "Maximum response body size read for validation and schema fingerprinting.", "default": 200000 }, "concurrency": { "title": "Concurrent requests", "minimum": 1, "maximum": 4, "type": "integer", "description": "Maximum number of endpoint checks performed at the same time.", "default": 3 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }