{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker: Find 404s and Redirects on Any Website", "description": "Crawl a website and check every link, image, script and stylesheet: 404s, server errors, dead domains and redirect chains. One row per problem link with the page it was found on. Links that cannot be checked are free.", "version": "0.1", "x-build-id": "Alh6Fd0HqGY3Z7oc5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boubap~broken-links-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boubap-broken-links-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/boubap~broken-links-checker/runs": { "post": { "operationId": "runs-sync-boubap-broken-links-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/boubap~broken-links-checker/run-sync": { "post": { "operationId": "run-sync-boubap-broken-links-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Pages where the crawl starts, for example your home page. Pages of the same site (same domain, with or without www) are followed from there. To check only the pages you list, set Max depth to 0.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of pages of the site that are opened and read for links. Links found on them are all checked, including images, scripts, stylesheets and links to other sites. Default 100, up to 5000. Pages with many links to other sites take about 9 seconds each: above roughly 700 pages, raise the run timeout (2 hours by default).", "default": 100 }, "maxDepth": { "title": "Max depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many clicks away from a start URL the crawl goes. 0 checks the links of the start URLs only, 1 also reads the pages they link to, and so on. Default 10.", "default": 10 }, "checkExternalLinks": { "title": "Check links to other sites", "type": "boolean", "description": "Also check links that point to other domains (one request per address, never crawled). Turn off to check your own site only.", "default": true }, "includeOkLinks": { "title": "Include working links", "type": "boolean", "description": "Off: the dataset lists broken and redirected links, plus links that could not be checked (blocked or error). On: it also lists working links. Links skipped because of robots.txt are never listed. The price is the same either way.", "default": false }, "maxConcurrency": { "title": "Parallel requests to the site", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many requests are sent at once to the crawled site. Default 4, up to 10. A Crawl-delay in the site's robots.txt is honored up to 10 seconds. Other sites always get at most 2 requests at once.", "default": 4 }, "urls": { "title": "URLs to check (no crawl)", "type": "array", "description": "A list of addresses to check one by one, up to 10000, for example after a site migration or for a list of backlinks. When filled, nothing is crawled and Start URLs are ignored. Each address gets one row with its status, the redirect chain and the final address. Duplicates are checked once.", "items": { "type": "string" } }, "maxRedirects": { "title": "Max redirects (URL list)", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many redirects are followed for each address of the URL list before it is reported as a redirect loop. Default 10, from 1 to 20.", "default": 10 } } }, "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 } } } } } } } } } }