{ "openapi": "3.0.1", "info": { "title": "Scrape Source Health and Block Monitor", "description": "Check each scrape source with a plain HTTP fetch and a body marker. Keep consecutive-failure, quarantine, and recovery counters between runs, and report the sources that changed state.", "version": "0.2", "x-build-id": "xRmhvN0VdCRzXA3K5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~scrape-source-health-and-block-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-scrape-source-health-and-block-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/kingii98~scrape-source-health-and-block-monitor/runs": { "post": { "operationId": "runs-sync-kingii98-scrape-source-health-and-block-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/kingii98~scrape-source-health-and-block-monitor/run-sync": { "post": { "operationId": "run-sync-kingii98-scrape-source-health-and-block-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": [ "sources" ], "properties": { "sources": { "title": "Sources", "minItems": 1, "maxItems": 200, "type": "array", "description": "Source definitions to check. Each item needs id and url, and accepts method (GET or HEAD), expectedStatus, requiredText, and minBytes (maximum 200000, the body read cap). Maximum 200 sources per run. If you leave this field empty, the Actor checks the two public example sources shown below.", "default": [ { "id": "example-com-home", "url": "https://example.com/", "method": "GET", "expectedStatus": 200, "requiredText": "Example Domain", "minBytes": 200 }, { "id": "example-org-home", "url": "https://example.org/", "method": "GET", "expectedStatus": 200, "requiredText": "Example Domain", "minBytes": 200 } ] }, "failureThreshold": { "title": "Failure threshold", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of consecutive failed checks that moves a source from DEGRADED to ALERT.", "default": 3 }, "quarantineThreshold": { "title": "Quarantine threshold", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of consecutive failed checks that moves a source to QUARANTINED. Must be equal to or greater than the failure threshold.", "default": 10 }, "recoveryProbes": { "title": "Recovery probes", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of consecutive successful checks that a failed source needs to return to OK. Until then the source stays RECOVERING.", "default": 3 }, "stateKey": { "title": "State record key", "type": "string", "description": "Name of the key-value store record that carries the counters between runs. Use one key per fleet. The record is written once, at the end of the run.", "default": "SOURCE_HEALTH_STATE" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of sources checked concurrently.", "default": 10 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 2, "maximum": 60, "type": "integer", "description": "Per-request timeout applied to each fetch. A source that exceeds it gets the TIMEOUT reason code.", "default": 20 }, "maxRedirects": { "title": "Maximum redirects", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum redirect hops followed per source. A chain that repeats a URL gets the REDIRECT_LOOP reason code.", "default": 5 } } }, "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 } } }, "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 } } } } } } } } } }