# Sitemap Broken Link Auditor (`snapperwapper/sitemap-broken-link-auditor`) Actor Audit XML sitemaps and sitemap indexes for broken URLs, redirects, status codes, response times, duplicate entries, and structured errors. - **URL**: https://apify.com/snapperwapper/sitemap-broken-link-auditor.md - **Developed by:** [snapperwapper](https://apify.com/snapperwapper) (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 Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## 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 ## Sitemap Broken Link Auditor Audit XML sitemaps and nested sitemap indexes for broken URLs and redirects. Designed for recurring technical SEO, migration QA, and agency maintenance checks. ### What it returns - HTTP status and issue class for every stored URL - Redirect target for 3xx responses - Response time and content type - Source and root sitemap - Sitemap metadata: `lastmod`, `changefreq`, and priority - Duplicate-entry counts in the run summary - Structured request and invalid-sitemap errors By default, the dataset contains only problems, keeping scheduled exports small. Disable **Save only problems** to keep all checked URLs. ### Example input ```json {"sitemapUrls":["https://www.sitemaps.org/sitemap.xml"],"maxUrls":1000,"maxConcurrency":10,"timeoutSecs":20,"onlyIssues":true} ```` ### Good uses - Scheduled sitemap health monitoring - SEO migration and redesign QA - Agency audits across multiple client sitemaps - Finding stale 404/5xx URLs submitted to search engines - Detecting submitted URLs that now redirect ### Scope and responsible use The Actor reads standard XML sitemaps and performs one ordinary HTTP request per unique URL. It does not crawl beyond sitemap entries or bypass access controls. Only audit sites you are permitted to access, and respect site terms and applicable law. ### Pricing Published as standard Apify pay-per-usage while traffic is validated. It uses no browser, login, proxy, or paid external API by default. # Actor input Schema ## `sitemapUrls` (type: `array`): Up to 100 XML sitemap or sitemap-index URLs to audit. ## `maxUrls` (type: `integer`): Maximum unique and duplicate sitemap entries collected before auditing. ## `maxConcurrency` (type: `integer`): Number of sitemap URLs checked in parallel. ## `timeoutSecs` (type: `integer`): Maximum seconds allowed for each sitemap or page response. ## `onlyIssues` (type: `boolean`): Store only redirects, broken URLs, request failures, and sitemap errors. Disable to store all checked URLs. ## Actor input object example ```json { "sitemapUrls": [ "https://www.sitemaps.org/sitemap.xml" ], "maxUrls": 1000, "maxConcurrency": 10, "timeoutSecs": 20, "onlyIssues": true } ``` # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("snapperwapper/sitemap-broken-link-auditor").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 = {} # Run the Actor and wait for it to finish run = client.actor("snapperwapper/sitemap-broken-link-auditor").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 '{}' | apify call snapperwapper/sitemap-broken-link-auditor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=snapperwapper/sitemap-broken-link-auditor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap Broken Link Auditor", "description": "Audit XML sitemaps and sitemap indexes for broken URLs, redirects, status codes, response times, duplicate entries, and structured errors.", "version": "0.1", "x-build-id": "HXyw0Ew9EM0RbKyAU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/snapperwapper~sitemap-broken-link-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-snapperwapper-sitemap-broken-link-auditor", "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/snapperwapper~sitemap-broken-link-auditor/runs": { "post": { "operationId": "runs-sync-snapperwapper-sitemap-broken-link-auditor", "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/snapperwapper~sitemap-broken-link-auditor/run-sync": { "post": { "operationId": "run-sync-snapperwapper-sitemap-broken-link-auditor", "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": [ "sitemapUrls" ], "properties": { "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Up to 100 XML sitemap or sitemap-index URLs to audit.", "items": { "type": "string" }, "default": [ "https://www.sitemaps.org/sitemap.xml" ] }, "maxUrls": { "title": "Maximum URLs per root sitemap", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum unique and duplicate sitemap entries collected before auditing.", "default": 1000 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of sitemap URLs checked in parallel.", "default": 10 }, "timeoutSecs": { "title": "Timeout per request", "minimum": 3, "maximum": 60, "type": "integer", "description": "Maximum seconds allowed for each sitemap or page response.", "default": 20 }, "onlyIssues": { "title": "Save only problems", "type": "boolean", "description": "Store only redirects, broken URLs, request failures, and sitemap errors. Disable to store all checked URLs.", "default": true } } }, "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 } } } } } } } } } } ```