{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker — Find Dead Links on Any Website", "description": "Check every link on a website, its sitemap or a plain URL list: one row per link with status, broken / blocked / redirect result, redirect chain, link text and linking pages. Images and scripts too, or only the problems. Part of NexGen Signal — data tools and official-source data products", "version": "0.1", "x-build-id": "XzJtBRiUCaa6LXbK6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgensignal~broken-link-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgensignal-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/nexgensignal~broken-link-checker/runs": { "post": { "operationId": "runs-sync-nexgensignal-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/nexgensignal~broken-link-checker/run-sync": { "post": { "operationId": "run-sync-nexgensignal-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", "properties": { "startUrls": { "title": "Websites to check", "type": "array", "description": "Start pages. Pages on the same site (www and non-www count as one) are read for more links. Up to 100. Leave empty to check only a plain list (linkUrls).", "items": { "type": "string" } }, "linkUrls": { "title": "Plain list of links to check", "type": "array", "description": "Links to check as they are, without opening any page for more links (up to 50,000). Can be combined with startUrls.", "default": [], "items": { "type": "string" } }, "useSitemaps": { "title": "Also read pages from the sitemap", "type": "boolean", "description": "For each website, also open the pages listed in its sitemap (from robots.txt, or /sitemap.xml), up to maxPages.", "default": false }, "maxPages": { "title": "Maximum pages to read", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many pages of your site are opened and read for links. Every link found on them is checked.", "default": 100 }, "maxDepth": { "title": "Maximum click depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many clicks from the start page to follow (0 = start pages only).", "default": 10 }, "checkExternalLinks": { "title": "Check links to other sites", "type": "boolean", "description": "Off = only links within your site are checked.", "default": true }, "checkResources": { "title": "Also check images, scripts and stylesheets", "type": "boolean", "description": "Also check img, script, stylesheet, icon, iframe, video and audio sources.", "default": false }, "onlyBroken": { "title": "Only deliver broken links", "type": "boolean", "description": "On = only broken and unreachable links are delivered and billed; every link is still checked.", "default": false }, "includeRedirects": { "title": "With 'only broken', also deliver redirects", "type": "boolean", "description": "Also deliver links that work but go through redirects (useful to update old links).", "default": false }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Treat subdomains (e.g. blog.example.com) as the same site.", "default": false }, "includeUrlPatterns": { "title": "Only read pages matching", "type": "array", "description": "Regular expressions; when set, only matching pages of your site are read for links (links on them are all checked).", "default": [], "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Do not read pages matching", "type": "array", "description": "Regular expressions for pages not to read, e.g. /search or \\?page=", "default": [], "items": { "type": "string" } }, "requestTimeoutSecs": { "title": "Seconds to wait for an answer", "minimum": 3, "maximum": 120, "type": "integer", "description": "A link that has not answered by then is retried once, then reported as unreachable.", "default": 25 }, "slowThresholdMs": { "title": "Slow link threshold (ms)", "minimum": 100, "maximum": 60000, "type": "integer", "description": "Links slower than this get slow = true.", "default": 5000 }, "maxLinks": { "title": "Maximum links delivered", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many links are delivered. Each delivered link is billed once, however many pages it appears on.", "default": 10000 } } }, "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 } } } } } } } } } }