{ "openapi": "3.0.1", "info": { "title": "Competitor Website Monitor – New Products & Pages, Sitemap", "description": "Get alerted to every new, removed or updated URL on competitor sites: new products, landing pages, blog posts. Schedule daily. $3 per 1,000 checks.", "version": "1.0", "x-build-id": "6KoMm3TKkfTJ45wvx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fast_data_asap~sitemap-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fast_data_asap-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/fast_data_asap~sitemap-change-monitor/runs": { "post": { "operationId": "runs-sync-fast_data_asap-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/fast_data_asap~sitemap-change-monitor/run-sync": { "post": { "operationId": "run-sync-fast_data_asap-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", "required": [ "domains" ], "properties": { "domains": { "title": "Domains or sitemap URLs", "type": "array", "description": "Websites to monitor, e.g. competitor.com, https://shop.example.com, or a direct sitemap URL like https://example.com/sitemap_products_1.xml. Sitemaps are found automatically via robots.txt and common paths (sitemap indexes and .gz supported).", "default": [ "https://blog.apify.com" ], "items": { "type": "string" } }, "includePatterns": { "title": "Only URLs containing", "type": "array", "description": "Optional. Only track URLs matching at least one of these patterns (plain text or regular expression), e.g. /products/, /blog/, /p/. Changing the patterns starts a new baseline.", "items": { "type": "string" } }, "excludePatterns": { "title": "Ignore URLs containing", "type": "array", "description": "Optional. URLs matching any of these patterns (plain text or regex) are ignored, e.g. /tag/, /author/, ?page=.", "items": { "type": "string" } }, "stateKey": { "title": "State key (monitor name)", "type": "string", "description": "Name of this monitor. The URL snapshot of each domain is stored under this key in the named key-value store 'sitemap-change-monitor-state', and the next run with the same key reports changes against it. Use different keys for independent monitors of the same domain.", "default": "default" }, "emitBaseline": { "title": "Output all URLs on the first run", "type": "boolean", "description": "On the first run of a domain (baseline) only a summary row is output. Turn this on to also output every URL as a 'new' row (isBaseline = true).", "default": false }, "trackLastmod": { "title": "Report updated URLs (lastmod changed)", "type": "boolean", "description": "Report URLs whose date in the sitemap changed since the last run as 'updated'.", "default": true }, "maxUrlsPerDomain": { "title": "Max URLs per domain", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Safety limit for very large sites. If reached, removed URLs are not reported for that run (the snapshot would be incomplete).", "default": 100000 }, "maxChangeRowsPerDomain": { "title": "Max change rows per domain", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Caps the number of change rows output per domain and run (e.g. when a site is restructured). The summary row always has the full counts.", "default": 10000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. By default sitemaps are fetched directly and an Apify proxy is only used as fallback when a site blocks the request." } } }, "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 } } } } } } } } } }