{ "openapi": "3.0.1", "info": { "title": "Sitemap SEO Audit & Monitor - Broken Links & Hreflang", "description": "Audit every page in your sitemap: broken links, redirects, noindex, canonicals, titles, meta descriptions, hreflang, AI-crawler robots.txt. Alerts on changes.", "version": "0.1", "x-build-id": "91jjkPz10q7QYuIja" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prevailing_glow~sitemap-seo-audit-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prevailing_glow-sitemap-seo-audit-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/prevailing_glow~sitemap-seo-audit-monitor/runs": { "post": { "operationId": "runs-sync-prevailing_glow-sitemap-seo-audit-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/prevailing_glow~sitemap-seo-audit-monitor/run-sync": { "post": { "operationId": "run-sync-prevailing_glow-sitemap-seo-audit-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": { "startUrl": { "title": "Website or sitemap URL", "type": "string", "description": "A homepage (e.g. https://example.com; the sitemap is found via robots.txt and common locations) or a sitemap / sitemap index URL. One site per run." }, "urlList": { "title": "Page URLs (instead of a sitemap)", "type": "array", "description": "Audit exactly these pages instead of the sitemap. All URLs must be on one site; others are ignored.", "items": { "type": "string" } }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of pages to audit. Large sitemaps are sampled evenly across their sitemap files. Each audited page is one billable event.", "default": 500 }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links to other websites (slower). Internal links are always checked.", "default": false }, "maxLinkChecks": { "title": "Max link checks", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Maximum number of distinct link targets fetched for the broken-link check (targets that were audited as pages are free). 0 disables extra link requests.", "default": 1000 }, "compareWithPreviousRun": { "title": "Compare with the previous run", "type": "boolean", "description": "Store this run's results per site and report new issues, fixed issues, new 404s and newly noindexed pages compared with the previous run. Schedule the Actor to monitor a site.", "default": true }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that keeps the per-site state between runs. Use different names to keep separate histories.", "default": "sitemap-seo-audit-state" }, "followLinksIfNoSitemap": { "title": "Follow internal links if no sitemap is found", "type": "boolean", "description": "When the site has no sitemap, discover pages by following internal links from the homepage.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Do not fetch pages that robots.txt disallows for this crawler, and honour Crawl-delay (up to 10 s). Blocked pages are reported for free.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests to the site. Keep it low to be polite.", "default": 4 }, "minDelayBetweenRequestsMs": { "title": "Min delay between requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Minimum time between two requests to the same host.", "default": 150 }, "requestTimeoutSecs": { "title": "Request timeout (s)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Timeout for a single request.", "default": 20 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 6, "type": "integer", "description": "Retries for network errors, 429 and 503 responses.", "default": 2 }, "userAgent": { "title": "User agent", "type": "string", "description": "User-Agent header. robots.txt rules are matched against its product token. Leave empty for the default." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional proxy. Usually not needed for your own site.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }