{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker ยท 404s with Page & Anchor, Only New Ones", "description": "Crawl your website and find broken links, 404s, server errors and redirects, with the exact page and anchor text to fix. On a schedule it reports only newly broken links. Respects robots.txt and tells 'blocked' apart from 'broken'.", "version": "0.1", "x-build-id": "rsVaUgRzuDCnXeedP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thequietstack~broken-link-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thequietstack-broken-link-checker", "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/thequietstack~broken-link-checker/runs": { "post": { "operationId": "runs-sync-thequietstack-broken-link-checker", "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/thequietstack~broken-link-checker/run-sync": { "post": { "operationId": "run-sync-thequietstack-broken-link-checker", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Websites", "type": "array", "description": "Home pages or sections of sites you own or may check. The crawl stays on the same host.", "items": { "type": "string" } }, "maxPages": { "title": "Maximum pages per site", "minimum": 1, "type": "integer", "description": "Pages that are opened to look for links.", "default": 200 }, "maxLinks": { "title": "Maximum links per run", "minimum": 1, "type": "integer", "description": "Hard cap on checked links, and therefore on the bill.", "default": 2000 }, "checkExternal": { "title": "Check links to other websites", "type": "boolean", "description": "One request per external link, only where that site's robots.txt allows it.", "default": true }, "checkAssets": { "title": "Check images, scripts and stylesheets", "type": "boolean", "description": "Also checks img, script and stylesheet addresses.", "default": true }, "useSitemap": { "title": "Start from the sitemap as well", "type": "boolean", "description": "Adds pages from the sitemaps named in robots.txt, so pages without internal links are found too.", "default": true }, "includeRedirects": { "title": "Report redirects", "type": "boolean", "description": "Adds rows for links that work but redirect. Useful for link hygiene.", "default": false }, "includeBlocked": { "title": "Report links that refused the check", "type": "boolean", "description": "401, 403 and 429 mean the site refused an automated check, not that the link is broken. These rows have problem = blocked.", "default": true }, "onlyNew": { "title": "Only newly broken links", "type": "boolean", "description": "Remembers problems between runs and writes only new ones. Links are still checked and charged. The site summary row counts what was fixed.", "default": false }, "stateStoreName": { "title": "Memory store", "type": "string", "description": "Named key-value store for the memory. Use different names for different watch lists.", "default": "thequietstack-broken-link-state" }, "delayMs": { "title": "Pause per website (ms)", "minimum": 200, "type": "integer", "description": "Minimum pause between two requests to the same host. A longer Crawl-delay in robots.txt wins.", "default": 500 }, "concurrency": { "title": "Hosts at the same time", "minimum": 1, "maximum": 10, "type": "integer", "description": "A single host never gets parallel requests.", "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 }, "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 } } } } } } } } } }