{ "openapi": "3.0.1", "info": { "title": "Sitemap URL Inventory & Change API", "version": "0.1", "x-build-id": "TEqPhoeDnJDJxmjIf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ursog~sitemap-url-inventory-change-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ursog-sitemap-url-inventory-change-api", "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/ursog~sitemap-url-inventory-change-api/runs": { "post": { "operationId": "runs-sync-ursog-sitemap-url-inventory-change-api", "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/ursog~sitemap-url-inventory-change-api/run-sync": { "post": { "operationId": "run-sync-ursog-sitemap-url-inventory-change-api", "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": [ "sourceRightsConfirmed" ], "properties": { "sitemapUrls": { "title": "Explicit sitemap URLs", "maxItems": 50, "type": "array", "description": "Configure Explicit sitemap URLs.", "items": { "type": "string", "maxLength": 2048 }, "default": [] }, "domains": { "title": "Domains to discover", "maxItems": 50, "type": "array", "description": "Checks robots.txt Sitemap declarations, then the conventional /sitemap.xml fallback.", "items": { "type": "string", "maxLength": 253 }, "default": [] }, "monitorKey": { "title": "Monitor key", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$", "maxLength": 256, "type": "string", "description": "Configure Monitor key.", "default": "default" }, "emitBaselineUrls": { "title": "Emit capped baseline URL rows", "type": "boolean", "description": "Configure Emit capped baseline URL rows.", "default": false }, "maxBaselineRows": { "title": "Maximum baseline URL rows", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Configure Maximum baseline URL rows.", "default": 100 }, "maxTargets": { "title": "Maximum targets", "minimum": 1, "maximum": 50, "type": "integer", "description": "Configure Maximum targets.", "default": 50 }, "maxSitemapDocuments": { "title": "Maximum sitemap documents per target", "minimum": 1, "maximum": 100, "type": "integer", "description": "Configure Maximum sitemap documents per target.", "default": 100 }, "maxDepth": { "title": "Maximum nested index depth", "minimum": 0, "maximum": 5, "type": "integer", "description": "Configure Maximum nested index depth.", "default": 5 }, "maxUrls": { "title": "Maximum URLs across the run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Configure Maximum URLs across the run.", "default": 50000 }, "maxConcurrency": { "title": "Concurrent targets", "minimum": 1, "maximum": 20, "type": "integer", "description": "Configure Concurrent targets.", "default": 6 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 3, "maximum": 30, "type": "integer", "description": "Configure Request timeout.", "default": 12 }, "maxRequestRetries": { "title": "Retries", "minimum": 0, "maximum": 1, "type": "integer", "description": "Configure Retries.", "default": 1 }, "maxWireBytes": { "title": "Maximum wire bytes per document", "minimum": 10000, "maximum": 25000000, "type": "integer", "description": "Configure Maximum wire bytes per document.", "default": 5000000 }, "maxDecodedBytes": { "title": "Maximum decoded bytes per document", "minimum": 10000, "maximum": 25000000, "type": "integer", "description": "Configure Maximum decoded bytes per document.", "default": 20000000 }, "maxRedirects": { "title": "Maximum redirects", "minimum": 0, "maximum": 8, "type": "integer", "description": "Configure Maximum redirects.", "default": 5 }, "sourceRightsConfirmed": { "title": "I confirm source rights", "type": "boolean", "description": "Required. Confirm that every submitted public URL is owned by you or that you are authorized to automate access and process the resulting metadata under the source terms and applicable law." } } }, "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 } } } } } } } } } }