# Broken Link & Asset Checker (`x2ppi/website-broken-link-asset-checker`) Actor Website release QA: checks public pages for broken links, images, scripts, and stylesheets with repair actions. - **URL**: https://apify.com/x2ppi/website-broken-link-asset-checker.md - **Developed by:** [Yota](https://apify.com/x2ppi) (community) - **Categories:** SEO tools, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $24.00 / 1,000 completed page audits This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Broken Link & Asset Checker Check public HTML pages for broken links, images, scripts, and stylesheets before a content publish or website release. Each Dataset record gives the source page status, broken-target evidence, a pass/needs-attention verdict, and a concrete next action. ### Best for - Release QA for landing pages, documentation, and campaign pages - Content migrations where old assets or internal links may have been removed - Scheduled checks of a small, known set of critical public pages ### Start with the ready-made release check Use the public [Check Website Links & Assets Before Release](https://apify.com/x2ppi/website-broken-link-asset-checker/examples/check-release-page-links-and-assets) task when you want a prefilled, bounded check before a launch. It checks one public page, keeps external-target checks off, and caps the run at 10 discovered targets. Duplicate the task, replace the page URL, and run it from the Apify Console. ### Input ```json { "startUrls": [{ "url": "https://example.com/" }], "includeExternalLinks": false, "maxTargetsPerPage": 50, "requestTimeoutSecs": 15 } ```` By default, the Actor checks only same-host targets. Turn on `includeExternalLinks` when your release QA should also test outgoing links. Set a lower target cap for a fast smoke test. ### Output - `verdict: "pass"`: all checked targets returned a successful or redirect HTTP response. - `verdict: "needs-attention"`: `brokenTargets` identifies each target URL, kind, status or request error, and a repair action. - `verdict: "source-unreachable"`: the source page could not be checked. The diagnostic is stored, but it is not billed. ### Pricing - From $0.03 per completed source-page audit (Free-tier price; eligible higher tiers receive a progressive Store discount) - A page is charged only after its reachable audit result is written to the default Dataset. - Source-page access failures are stored as uncharged diagnostics. For example, checking 100 reachable pages costs up to $3.00 at the Free-tier price. Use the maximum charge setting in Apify to cap a run before it starts. ### Automate it Run the Actor from a deployment script, CI job, or any Apify integration. Keep the token outside source control and pass it as an environment variable: ```bash curl -X POST "https://api.apify.com/v2/acts/x2ppi~website-broken-link-asset-checker/runs?token=$APIFY_TOKEN" \ -H "Content-Type: application/json" \ -d '{"startUrls":[{"url":"https://www.example.com/release-page"}],"includeExternalLinks":false,"maxTargetsPerPage":50}' ``` For recurring checks, save the input as an Apify task and attach a schedule or webhook in the Console. Treat `needs-attention` results as a release gate: fix each listed target or document why it is intentionally unavailable. ### Safety and boundaries The Actor performs bounded public HTTP checks only: it rejects local and non-public network destinations, validates redirect destinations again, follows at most five redirects, reads at most 2 MiB for each source page, and checks at most 100 discovered targets per page. It does not authenticate, bypass access controls, use a proxy, or confirm SEO rankings, accessibility compliance, or full-site crawl coverage. # Actor input Schema ## `startUrls` (type: `array`): Public HTML pages whose links, images, scripts, and stylesheets should be checked. Maximum 100 unique pages. ## `includeExternalLinks` (type: `boolean`): When off, only same-host links and assets are checked. Turn on for a release-wide outgoing-link check. ## `maxTargetsPerPage` (type: `integer`): Caps checked discovered targets for predictable run time. ## `requestTimeoutSecs` (type: `integer`): Stops an individual page or target request after this number of seconds. ## Actor input object example ```json { "startUrls": [ { "url": "https://example.com/" } ], "includeExternalLinks": false, "maxTargetsPerPage": 50, "requestTimeoutSecs": 15 } ``` # Actor output Schema ## `pageAuditResults` (type: `string`): One stored result per completed source-page audit, including broken links, asset evidence, verdict, and repair actions. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrls": [ { "url": "https://example.com/" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("x2ppi/website-broken-link-asset-checker").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrls": [{ "url": "https://example.com/" }] } # Run the Actor and wait for it to finish run = client.actor("x2ppi/website-broken-link-asset-checker").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "startUrls": [ { "url": "https://example.com/" } ] }' | apify call x2ppi/website-broken-link-asset-checker --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=x2ppi/website-broken-link-asset-checker", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Broken Link & Asset Checker", "description": "Website release QA: checks public pages for broken links, images, scripts, and stylesheets with repair actions.", "version": "0.1", "x-build-id": "tAhg3MIf96teVOvSi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/x2ppi~website-broken-link-asset-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-x2ppi-website-broken-link-asset-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/x2ppi~website-broken-link-asset-checker/runs": { "post": { "operationId": "runs-sync-x2ppi-website-broken-link-asset-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/x2ppi~website-broken-link-asset-checker/run-sync": { "post": { "operationId": "run-sync-x2ppi-website-broken-link-asset-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": "Pages to check", "type": "array", "description": "Public HTML pages whose links, images, scripts, and stylesheets should be checked. Maximum 100 unique pages.", "items": { "type": "object", "properties": { "url": { "title": "Page URL", "type": "string", "description": "Public http or https page URL." } }, "required": [ "url" ] } }, "includeExternalLinks": { "title": "Check external links and assets", "type": "boolean", "description": "When off, only same-host links and assets are checked. Turn on for a release-wide outgoing-link check.", "default": false }, "maxTargetsPerPage": { "title": "Maximum links and assets per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Caps checked discovered targets for predictable run time.", "default": 50 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 3, "maximum": 60, "type": "integer", "description": "Stops an individual page or target request after this number of seconds.", "default": 15 } } }, "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 } } }, "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 } } } } } } } } } } ```