{ "openapi": "3.0.1", "info": { "title": "Website Link Health - Broken Links & Recovery", "description": "Check links from public HTML pages with referring-page and anchor evidence, redirect chains, confirmed HTTP statuses and saved new/recovered issue tracking. No API key.", "version": "1.0", "x-build-id": "nIbmKHsPFqxg9uutX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maydit~website-link-health-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maydit-website-link-health-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/maydit~website-link-health-monitor/runs": { "post": { "operationId": "runs-sync-maydit-website-link-health-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/maydit~website-link-health-monitor/run-sync": { "post": { "operationId": "run-sync-maydit-website-link-health-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", "properties": { "startUrls": { "title": "Pages to inspect", "type": "array", "description": "Public HTTP(S) page URLs. The Actor reads links on these exact pages; it does not crawl onward. Up to20URLs.", "default": [ "https://crawler-test.com/links/broken_links_internal" ], "items": { "type": "string" } }, "checkExternal": { "title": "Check external links", "type": "boolean", "description": "Check links pointing to other origins as well as links on the source site. External pages are never crawled.", "default": true }, "includeImages": { "title": "Include image sources", "type": "boolean", "description": "Also inspect image src URLs from the supplied HTML; srcset, CSS backgrounds, scripts and stylesheets are outside scope.", "default": false }, "maxPages": { "title": "Maximum source pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Read at most this many supplied URLs. Unreached input pages make the run incomplete and prevent baseline updates.", "default": 5 }, "maxLinks": { "title": "Maximum unique targets", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum unique discovered target URLs to check. If more are present, the run reports partial coverage and leaves saved history unchanged.", "default": 100 }, "maxResults": { "title": "Maximum saved rows", "minimum": 1, "maximum": 500, "type": "integer", "description": "One charged row per unique checked URL. Lowering this below the discovered target count creates partial coverage.", "default": 100 }, "comparePrevious": { "title": "Compare with a saved baseline", "type": "boolean", "description": "Save a complete determinate result set and compare later matching runs. First run establishes the baseline. Incomplete runs never advance it.", "default": false }, "onlyChanges": { "title": "Save changed targets only", "type": "boolean", "description": "Implies comparison. Skip targets whose HTTP classification, status, destination and redirect chain are unchanged. A missing link is never called recovered.", "default": false }, "snapshotName": { "title": "Baseline label", "pattern": "^[-\\w]{1,80}$", "type": "string", "description": "Use a stable label of1-80letters, numbers, underscores or hyphens for a watchlist; avoid overlapping writers.", "default": "default" }, "maxRequests": { "title": "Maximum HTTP requests", "minimum": 10, "maximum": 1500, "type": "integer", "description": "Hard ceiling covering source pages, robots.txt, redirects and target checks. Reaching the ceiling reports partial coverage.", "default": 350 }, "maxRunSeconds": { "title": "Run time budget (seconds)", "minimum": 30, "maximum": 180, "type": "integer", "description": "Stop within this time budget, retaining saved results and explicit incomplete coverage. No automatic proxy or paid fallback.", "default": 90 } } }, "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 } } } } } } } } } }