# Sitemap Health Audit - XML Sitemap Validator (`artifact-machine/artifact-machine-sitemap-health-audit`) Actor Check XML sitemap health, freshness, and crawlability signals. - **URL**: https://apify.com/artifact-machine/artifact-machine-sitemap-health-audit.md - **Developed by:** [The Artifact Machine](https://apify.com/artifact-machine) (community) - **Categories:** SEO tools, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $1.00 / sitemap health report This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. 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 ## The Artifact Machine Sitemap Health Audit A small artifact for checking whether a website exposes a healthy XML sitemap with useful discovery and freshness signals. Use this Actor before a site launch, migration, SEO review, or monthly crawlability check. It gives teams a compact report on whether a sitemap exists, how it was discovered, how many URLs it exposes, and whether its metadata is useful enough for search and AI crawlers. Pulled from The Artifact Machine: generated, tested, and cleaned up by a human. ### What It Checks - `robots.txt` sitemap declarations - common sitemap locations such as `/sitemap.xml` - sitemap index files and child sitemap files - URL count, duplicate URL count, cross-host URLs, and HTTP URLs - `lastmod` coverage, stale dates, future dates, and most recent update date - fetch and parse errors that make the sitemap unreliable ### Best For - SEO and GEO audits - website migration checks - ecommerce sitemap reviews - agency client diagnostics - monthly crawlability monitoring ### Input ```json { "url": "https://example.com", "maxSitemapFiles": 10, "maxUrls": 500, "includeSamples": true } ```` #### Input Fields - `url`: homepage or canonical site URL to audit. - `maxSitemapFiles`: maximum sitemap index and child sitemap files to fetch. - `maxUrls`: maximum sitemap URLs to parse into the report. - `includeSamples`: include small URL samples in the output for debugging and client review. ### Output The Actor writes one dataset item and an `OUTPUT` key-value record with: - composite score and grade - sitemap discovery method and fetched sitemap files - URL inventory and freshness stats - issue counts by severity - actionable issues with impact and how-to-fix guidance Example output fields: - `score`: 0-100 sitemap health score - `grade`: A-F score band - `issueCounts`: issue totals by severity - `checks.discovery`: sitemap discovery and fetch results - `checks.inventory`: URL count, duplicates, protocol, host checks - `checks.freshness`: `lastmod` coverage and date quality - `issues`: prioritized fix list ### Limits - This Actor audits sitemap files reachable from one submitted website origin. - It does not crawl an entire website. - It caps fetched sitemap files and parsed URLs to keep runs predictable. - It does not guarantee search indexing or AI citation. - Some sites block automated requests differently from regular browsers, so results should be reviewed before client delivery. ### Pricing Use pay-per-event pricing based on completed reports rather than per issue. Suggested starting price: `$1.00` to `$2.00` per completed sitemap health report after private runtime cost is measured. # Actor input Schema ## `url` (type: `string`): The homepage or canonical site URL to audit. ## `maxSitemapFiles` (type: `integer`): Maximum sitemap index and child sitemap files to fetch. ## `maxUrls` (type: `integer`): Maximum sitemap URLs to parse into the report. ## `includeSamples` (type: `boolean`): Include small URL samples in the output for debugging and client review. ## Actor input object example ```json { "url": "https://example.com", "maxSitemapFiles": 10, "maxUrls": 500, "includeSamples": true } ``` # Actor output Schema ## `results` (type: `string`): Default dataset items. Each item contains the target URL, score, grade, sitemap discovery details, freshness stats, and actionable issues. ## `summary` (type: `string`): The same single-run summary stored as the OUTPUT key-value record. # 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 = { "url": "https://example.com" }; // Run the Actor and wait for it to finish const run = await client.actor("artifact-machine/artifact-machine-sitemap-health-audit").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 = { "url": "https://example.com" } # Run the Actor and wait for it to finish run = client.actor("artifact-machine/artifact-machine-sitemap-health-audit").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 '{ "url": "https://example.com" }' | apify call artifact-machine/artifact-machine-sitemap-health-audit --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=artifact-machine/artifact-machine-sitemap-health-audit", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap Health Audit - XML Sitemap Validator", "description": "Check XML sitemap health, freshness, and crawlability signals.", "version": "0.1", "x-build-id": "IhkoSe6snyO7dVLZ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/artifact-machine~artifact-machine-sitemap-health-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-artifact-machine-artifact-machine-sitemap-health-audit", "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/artifact-machine~artifact-machine-sitemap-health-audit/runs": { "post": { "operationId": "runs-sync-artifact-machine-artifact-machine-sitemap-health-audit", "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/artifact-machine~artifact-machine-sitemap-health-audit/run-sync": { "post": { "operationId": "run-sync-artifact-machine-artifact-machine-sitemap-health-audit", "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": [ "url" ], "properties": { "url": { "title": "Website URL", "type": "string", "description": "The homepage or canonical site URL to audit." }, "maxSitemapFiles": { "title": "Maximum sitemap files", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum sitemap index and child sitemap files to fetch.", "default": 10 }, "maxUrls": { "title": "Maximum URLs to inspect", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum sitemap URLs to parse into the report.", "default": 500 }, "includeSamples": { "title": "Include URL samples", "type": "boolean", "description": "Include small URL samples in the output for debugging and client review.", "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 } } } } } } } } } } ```