{ "openapi": "3.0.1", "info": { "title": "Sitemap Change Monitor: New Competitor Pages", "description": "Track new competitor pages: monitor public XML sitemaps (indexes and .xml.gz) and robots.txt and get only the URLs that were added, removed or whose lastmod changed since the last run. Often the first sign of a new landing page or campaign. Optional webhook. No browser, no proxy.", "version": "0.1", "x-build-id": "LABj5cuRbD6icHGtc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/singletonops~sitemap-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-singletonops-sitemap-change-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/singletonops~sitemap-change-monitor/runs": { "post": { "operationId": "runs-sync-singletonops-sitemap-change-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/singletonops~sitemap-change-monitor/run-sync": { "post": { "operationId": "run-sync-singletonops-sitemap-change-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": { "sitemapUrls": { "title": "Sitemap / robots.txt URLs", "type": "array", "description": "Public sitemap.xml, sitemap index, gzipped .xml.gz, or robots.txt URLs. For robots.txt the Actor reads Sitemap: directives and expands those sitemaps. Private or login-walled URLs are not supported.", "default": [ "https://apify.com/sitemap.xml" ], "items": { "type": "string" } }, "maxSitemaps": { "title": "Max sitemaps to fetch", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of sitemap documents to fetch while expanding sitemap indexes (including the root). Protects against huge indexes.", "default": 50 }, "maxUrls": { "title": "Max URLs to track", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Maximum number of page URLs to collect across all expanded sitemaps for this run. Bounds memory and key-value store size.", "default": 10000 }, "stateStoreName": { "title": "State key-value store name", "type": "string", "description": "Named Apify key-value store used to persist URL/lastmod baselines across scheduled runs. Use the same name for recurring monitoring.", "default": "sitemap-change-monitor-state" }, "stateKey": { "title": "State key", "type": "string", "description": "Record key inside the named store that holds the baseline map. Change this to keep separate baselines (e.g. per project).", "default": "sitemap-state" }, "emitAllOnFirstRun": { "title": "Emit all URLs on first run", "type": "boolean", "description": "When false (default), the first run only records a baseline and writes a summary — dataset stays empty. When true, every URL is emitted as changeType=added.", "default": false }, "includeUrlRegex": { "title": "Include URL regex", "type": "string", "description": "Optional JavaScript regex. When set, only page URLs matching this pattern are tracked (e.g. \".*/blog/.*\")." }, "excludeUrlRegex": { "title": "Exclude URL regex", "type": "string", "description": "Optional JavaScript regex. Matching page URLs are ignored (e.g. \".*\\\\.(pdf|jpg)$\")." }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional HTTPS endpoint that receives a JSON POST when changes are found. Payload includes totals, per-root summaries, and a sample of up to 50 change rows." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-request HTTP timeout.", "default": 30 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries with exponential backoff for timeouts, 429, and 5xx responses.", "default": 3 } } }, "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 } } } } } } } } } }