{ "openapi": "3.0.1", "info": { "title": "Sitemap SEO Regression Monitor", "description": "Discover XML sitemaps, audit page SEO signals, and monitor status, redirects, canonical, noindex, metadata, H1, and sitemap regressions across runs.", "version": "0.1", "x-build-id": "YXmzylfFOTBjH5pmd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/produkdigitalali~sitemap-seo-regression-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-produkdigitalali-sitemap-seo-regression-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/produkdigitalali~sitemap-seo-regression-monitor/runs": { "post": { "operationId": "runs-sync-produkdigitalali-sitemap-seo-regression-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/produkdigitalali~sitemap-seo-regression-monitor/run-sync": { "post": { "operationId": "run-sync-produkdigitalali-sitemap-seo-regression-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": { "startUrls": { "title": "Website or sitemap URLs", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Public website roots or direct sitemap URLs. Website roots use robots.txt declarations first, then common sitemap paths.", "items": { "type": "string", "minLength": 1, "maxLength": 8192 } }, "sites": { "title": "Advanced site definitions", "maxItems": 100, "type": "array", "description": "Optional objects with url, stable siteId, and label. Use siteId when a monitored site's input URL may change while its state identity should remain stable.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 8192, "title": "Site or sitemap URL", "description": "Public http(s) website root or direct XML/text sitemap URL." }, "siteId": { "type": "string", "maxLength": 120, "title": "Site ID", "description": "Optional stable monitoring identity used across related runs." }, "label": { "type": "string", "maxLength": 500, "title": "Label", "description": "Optional human-readable label copied to output records." } }, "additionalProperties": false }, "default": [] }, "maxSites": { "title": "Maximum sites", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum unique site definitions processed in one run.", "default": 20 }, "maxUrlsPerSite": { "title": "Maximum URLs per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on sitemap URLs audited per site. Large sitemaps are truncated at this limit.", "default": 500 }, "maxSitemapsPerSite": { "title": "Maximum sitemap files per site", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum sitemap/index files followed recursively for one site.", "default": 50 }, "maxSitemapDepth": { "title": "Maximum sitemap index depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum recursive sitemap-index depth.", "default": 5 }, "maxSitemapBytes": { "title": "Maximum sitemap bytes", "minimum": 1024, "maximum": 57671680, "type": "integer", "description": "Maximum downloaded/uncompressed bytes accepted for one sitemap file.", "default": 10485760 }, "includeUrlPrefixes": { "title": "Include URL prefixes", "maxItems": 50, "type": "array", "description": "If provided, only sitemap URLs beginning with at least one prefix are audited.", "items": { "type": "string", "maxLength": 8192 }, "default": [] }, "excludeUrlPrefixes": { "title": "Exclude URL prefixes", "maxItems": 50, "type": "array", "description": "Sitemap URLs beginning with any of these prefixes are skipped.", "items": { "type": "string", "maxLength": 8192 }, "default": [] }, "includeUrlRegex": { "title": "Include URL regex", "maxItems": 20, "type": "array", "description": "Optional case-insensitive regular expressions. A URL must match at least one pattern. Patterns are length-limited and time-bounded.", "items": { "type": "string", "maxLength": 300 }, "default": [] }, "excludeUrlRegex": { "title": "Exclude URL regex", "maxItems": 20, "type": "array", "description": "Optional case-insensitive regular expressions used to skip matching sitemap URLs.", "items": { "type": "string", "maxLength": 300 }, "default": [] }, "detectContentChanges": { "title": "Detect bounded page-content changes", "type": "boolean", "description": "Hash normalized visible HTML text so content changes can be detected across monitoring runs. Disabled by default to focus on technical SEO signals.", "default": false }, "includeSiteSummary": { "title": "Include site summary", "type": "boolean", "description": "Emit a SITE_SUMMARY record with discovery, issue, and change counts. Suppressed automatically in changes-only monitoring mode.", "default": true }, "monitorMode": { "title": "Monitoring mode", "type": "boolean", "description": "Persist bounded per-site snapshots and classify URL additions/removals, SEO regressions, recoveries, ordinary changes, and repeated page errors across runs.", "default": false }, "emitChangesOnly": { "title": "Emit changes only", "type": "boolean", "description": "When monitoring, suppress UNCHANGED page records so scheduled runs return only meaningful changes and status events.", "default": false }, "baselineOnly": { "title": "Quiet first baseline", "type": "boolean", "description": "On the first monitoring run for a site, save the current sitemap/page state without emitting every existing URL as URL_ADDED.", "default": false }, "monitorKey": { "title": "Monitor key", "maxLength": 200, "type": "string", "description": "Namespace for persistent monitoring state. Reuse the same value across related scheduled runs.", "default": "default" }, "concurrency": { "title": "Page concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum concurrent page audits across the run.", "default": 10 }, "siteConcurrency": { "title": "Site concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum site discovery pipelines processed concurrently.", "default": 3 }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 2, "maximum": 60, "type": "integer", "description": "Per-request timeout in seconds.", "default": 20 }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries transient timeout/network/429/5xx failures with bounded backoff.", "default": 2 }, "maxRedirects": { "title": "Maximum redirects", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum redirect hops per sitemap/page request. Every target is revalidated before following it.", "default": 5 }, "maxPageBytes": { "title": "Maximum page bytes", "minimum": 1024, "maximum": 5242880, "type": "integer", "description": "Maximum response body bytes downloaded for one audited page.", "default": 2097152 }, "userAgent": { "title": "User-Agent", "maxLength": 500, "type": "string", "description": "Optional HTTP User-Agent for public sitemap and page requests. CR/LF header injection is rejected.", "default": "Mozilla/5.0 (compatible; SitemapSEORegressionMonitor/0.1; +https://apify.com/)" } } }, "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 } } } } } } } } } }