{ "openapi": "3.0.1", "info": { "title": "Sitemap Health Monitor: Broken Links, 404 & Noindex Checker", "description": "Scheduled SEO audit of every URL in your sitemap: broken links, 404s, 5xx errors, redirect chains, noindex, canonical, robots.txt and hreflang conflicts. Each run diffs against the last one and reports new, still-broken and fixed issues, with a webhook alert on new ones.", "version": "0.1", "x-build-id": "BQ9bSN2TQJfN6cPAw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pankovs~sitemap-health-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pankovs-sitemap-health-monitor", "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/pankovs~sitemap-health-monitor/runs": { "post": { "operationId": "runs-sync-pankovs-sitemap-health-monitor", "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/pankovs~sitemap-health-monitor/run-sync": { "post": { "operationId": "run-sync-pankovs-sitemap-health-monitor", "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": { "siteUrl": { "title": "Website URL", "type": "string", "description": "Your site's homepage, e.g. example.com or https://www.example.com (https:// is added when missing). Sitemaps are discovered from the host's /robots.txt (Sitemap: lines), falling back to /sitemap.xml. Ignored when Sitemap URLs are set." }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Explicit sitemap or sitemap-index URLs (.xml, .xml.gz or plain-text). Overrides discovery from Website URL.", "items": { "type": "string" }, "default": [] }, "maxUrls": { "title": "Max URLs to check", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many sitemap URLs (each checked URL is one billable event).", "default": 500 }, "notifyWebhookUrl": { "title": "Webhook URL for new issues", "type": "string", "description": "Optional. When a run finds NEW issues or a sitemap starts failing, an alert is POSTed here. A Slack incoming webhook (hooks.slack.com) gets a readable message; Zapier, Make, n8n or your own endpoint get the full summary record as JSON. See Webhook format." }, "webhookFormat": { "title": "Webhook format", "enum": [ "auto", "slack", "json" ], "type": "string", "description": "Auto: a readable chat message for Slack URLs (hooks.slack.com), the full summary JSON for every other URL. Chat message: always send {\"text\": ...}, for Slack-compatible webhooks on other hosts (Mattermost, Rocket.Chat, Discord with /slack at the end of the URL). Summary JSON: always send the full summary record.", "default": "auto" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel URL checks.", "default": 5 }, "hostDelayMs": { "title": "Delay between requests to the same host (ms)", "minimum": 0, "type": "integer", "description": "Minimum spacing between requests to one host, so monitoring never strains your server.", "default": 250 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "A URL that does not respond in time is reported as a timeout issue.", "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 }, "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 } } } } } } } } } }