{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker: Find Dead Links on Any Site", "description": "Crawl a website and get every broken link (404, 410, 5xx, dead domains), internal and external, with the exact pages it appears on. Schedule it to see only newly broken and fixed links. Respects robots.txt. Pay per page crawled.", "version": "1.0", "x-build-id": "VWkdGhvap7yBSySuf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digital_influx~broken-links/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digital_influx-broken-links", "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/digital_influx~broken-links/runs": { "post": { "operationId": "runs-sync-digital_influx-broken-links", "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/digital_influx~broken-links/run-sync": { "post": { "operationId": "run-sync-digital_influx-broken-links", "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": [ "websites" ], "properties": { "websites": { "title": "Websites", "type": "array", "description": "One per line: a domain (example.com) or the URL where the crawl starts. Each website is crawled separately, following its internal links and its sitemap.", "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Pages crawled per website (each one is charged). The links on those pages are all checked.", "default": 100 }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links to other websites. Internal links are always checked.", "default": true }, "maxExternalLinksPerSite": { "title": "Max external links to check per website", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Unique external links checked per website.", "default": 500 }, "includeBlockedLinks": { "title": "List links the server refused", "type": "boolean", "description": "Links that answered 401, 403, 429 or 999 (LinkedIn). The server refused the checker; the page may well exist. Listed with state \"blocked\".", "default": true }, "includeOkLinks": { "title": "List working links too", "type": "boolean", "description": "Output every checked link, not only the problems (a full link inventory). Rows are free either way.", "default": false }, "useSitemap": { "title": "Use the sitemap", "type": "boolean", "description": "Also crawl pages listed in the sitemap that no link points to.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Recommended. Pages disallowed by robots.txt are not read, and external links on sites that disallow crawlers are not checked. Turn off only for your own website.", "default": true }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Requests to one website at the same time (1 to 10).", "default": 3 }, "compareWithPreviousRun": { "title": "Compare with the previous check (monitoring)", "type": "boolean", "description": "For scheduled checks: every broken link gets \"newlyBroken\" (true if it was not broken at the last check of the site), and the site row lists the links that were fixed and the broken links no page links to any more. The broken links of the last check are kept in a key-value store named \"broken-links-state\" in your account.", "default": false }, "stateKey": { "title": "Memory name (optional)", "type": "string", "description": "Give a name to keep a separate history, for example one per client, or a new name to start over." } } }, "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 } } } } } } } } } }