{ "openapi": "3.0.1", "info": { "title": "Sitemap Generator", "description": "Automatically crawl any website and generate XML, HTML, and text sitemaps for SEO optimization. Perfect for submitting to Google Search Console, Bing Webmaster Tools, and improving search engine indexing. no manual work required. Free sitemap generator tool for WordPress, Blogger, and all website.", "version": "1.0", "x-build-id": "lsLuKksg4N9MrnnT5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igview-owner~sitemap-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igview-owner-sitemap-generator", "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/igview-owner~sitemap-generator/runs": { "post": { "operationId": "runs-sync-igview-owner-sitemap-generator", "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/igview-owner~sitemap-generator/run-sync": { "post": { "operationId": "run-sync-igview-owner-sitemap-generator", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "List of URLs where the crawler will start. These should be the main pages of your website.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxCrawlDepth": { "title": "Max Crawl Depth", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum depth of links to follow from start URLs. Depth 0 means only start URLs, depth 1 includes pages linked from start URLs, etc.", "default": 3 }, "maxPagesPerCrawl": { "title": "Max Pages Per Crawl", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of pages to crawl. Use this to limit the scope of large websites.", "default": 30 }, "includePatterns": { "title": "Include URL Patterns", "type": "array", "description": "Regular expression patterns for URLs to include. If empty, all URLs from the same domain are included. Example: '^https://example\\.com/blog/.*'", "default": [], "items": { "type": "string" } }, "excludePatterns": { "title": "Exclude URL Patterns", "type": "array", "description": "Regular expression patterns for URLs to exclude. Useful for filtering out admin pages, login pages, etc. Example: '.*/admin/.*' or '.*\\?.*' to exclude URLs with query parameters", "default": [], "items": { "type": "string" } }, "sitemapFormats": { "title": "Sitemap Formats", "uniqueItems": true, "type": "array", "description": "Select which sitemap formats to generate", "items": { "type": "string", "enum": [ "xml", "html", "text" ] }, "default": [ "xml" ] }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Whether to respect the website's robots.txt file", "default": true }, "changefreq": { "title": "Change Frequency", "enum": [ "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ], "type": "string", "description": "How frequently the page is likely to change. This is used in the XML sitemap.", "default": "weekly" }, "defaultPriority": { "title": "Default Priority", "minimum": 0, "maximum": 1, "type": "number", "description": "Default priority for pages (0.0 to 1.0). The homepage automatically gets 1.0, and priority decreases with depth.", "default": 0.5 }, "includeImages": { "title": "Include Images", "type": "boolean", "description": "Include image URLs in the XML sitemap (following Google's image sitemap extension)", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the crawler. Use Apify Proxy for better reliability." } } }, "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 } } } } } } } } } }