{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker: crawl a site, find dead links", "description": "Crawls your site to the depth and page limit you set, checks every internal and external link it finds, and reports the status, redirect chain, response time, source pages and anchor text of each one.", "version": "0.1", "x-build-id": "jifU2JVazUsZZ2l0R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~broken-link-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-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/examsens.ai~broken-link-checker/runs": { "post": { "operationId": "runs-sync-examsens.ai-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/examsens.ai~broken-link-checker/run-sync": { "post": { "operationId": "run-sync-examsens.ai-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": "Sites to check", "type": "array", "description": "The page each crawl starts from, such as https://example.com. Each start URL is crawled as its own site. Pages on the same host, with or without www., count as internal.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many clicks from the start page to crawl. 0 checks only the links on the start page; 1 also crawls the internal pages it links to, and so on. Links found on the deepest pages are still checked.", "default": 2 }, "maxPages": { "title": "Maximum pages to crawl", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop opening new internal pages for links after this many, per start URL.", "default": 50 }, "maxLinksPerSite": { "title": "Maximum links per site", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop collecting new unique links after this many, per start URL. Each link checked is one billable event.", "default": 1000 }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links that point to other sites. External pages are checked but never crawled.", "default": true }, "checkAssets": { "title": "Check images, scripts, stylesheets and frames", "type": "boolean", "description": "Also check the URLs in img, script, iframe, and stylesheet and icon link elements, not only hyperlinks.", "default": false }, "onlyProblems": { "title": "Only output problem links", "type": "boolean", "description": "Leave out links that answered 2xx, directly or after redirects. Every link is still checked and billed.", "default": false }, "respectRobotsTxt": { "title": "Follow robots.txt", "type": "boolean", "description": "Do not request internal pages that the site's robots.txt disallows. They are listed with the category robotsDisallowed and not billed.", "default": true }, "slowThresholdMs": { "title": "Slow response threshold (ms)", "minimum": 100, "maximum": 120000, "type": "integer", "description": "Flag a link as slow when its response takes longer than this.", "default": 3000 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "How long to wait for each response. A link that times out is retried once with a GET request.", "default": 20 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many requests run at the same time. Lower it for small or fragile sites.", "default": 10 }, "userAgent": { "title": "User agent", "type": "string", "description": "The User-Agent header sent with every request. Leave empty to send Mozilla/5.0 (compatible; BrokenLinkChecker/1.0)." } } }, "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 } } } } } } } } } }