{ "openapi": "3.0.1", "info": { "title": "Find Broken Links & Redirect Chains on Any Website", "description": "Broken links frustrate visitors. Point this at your site and get a page-by-page hit list of 404s, broken images, redirect chains and loops, mixed content and noindex pages, with the exact page each problem lives on. Robots.txt respected.", "version": "0.1", "x-build-id": "gVVrDicUQsepYFb2S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/craigmckee~site-link-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-craigmckee-site-link-auditor", "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/craigmckee~site-link-auditor/runs": { "post": { "operationId": "runs-sync-craigmckee-site-link-auditor", "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/craigmckee~site-link-auditor/run-sync": { "post": { "operationId": "run-sync-craigmckee-site-link-auditor", "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": "Start URLs", "type": "array", "description": "Homepage (or any page) of the site to audit. The crawler stays on the same host (and its www/non-www twin).", "items": { "type": "string" } }, "maxPages": { "title": "Max pages to crawl", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of HTML pages crawled on your site. You are charged per page crawled; link checks are included.", "default": 100 }, "maxDepth": { "title": "Max click depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many clicks away from the start URL to follow.", "default": 10 }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links pointing to other websites (one HEAD/GET request per unique URL, robots.txt respected).", "default": true }, "checkResources": { "title": "Check images, scripts, stylesheets and iframes", "type": "boolean", "description": "Check embedded resources too, and flag mixed content (http resources on https pages).", "default": true }, "includeSubdomains": { "title": "Crawl subdomains", "type": "boolean", "description": "Treat subdomains (e.g. blog.example.com) as part of the site.", "default": false }, "excludeUrlPatterns": { "title": "Exclude URL patterns (regex)", "type": "array", "description": "Links matching any of these regular expressions are neither crawled nor checked, e.g. `/cart`, `\\?sort=`.", "default": [], "items": { "type": "string" } }, "includeAllLinks": { "title": "Include OK links in output", "type": "boolean", "description": "Also list links that returned 2xx (larger output). By default only problems are listed.", "default": false }, "maxConcurrency": { "title": "Max concurrency per host", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests per host. Keep this low to be polite.", "default": 4 }, "minDelaySecs": { "title": "Min delay between requests to the same host (seconds)", "minimum": 0, "maximum": 30, "type": "number", "description": "A robots.txt Crawl-delay, if larger, takes precedence.", "default": 0.25 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Timeout per request. Links timing out are reported as broken.", "default": 20 } } }, "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 } } } } } } } } } }