{ "openapi": "3.0.1", "info": { "title": "Sitemap & SEO Page Audit - Titles, Meta, H1, Links", "version": "0.1", "x-build-id": "bTPxwn57VB7oNB4Rx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~sitemap-seo-page-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-sitemap-seo-page-audit", "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/plotpointtech~sitemap-seo-page-audit/runs": { "post": { "operationId": "runs-sync-plotpointtech-sitemap-seo-page-audit", "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/plotpointtech~sitemap-seo-page-audit/run-sync": { "post": { "operationId": "run-sync-plotpointtech-sitemap-seo-page-audit", "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": { "websites": { "title": "Websites", "type": "array", "description": "Website home pages or sections to audit, e.g. https://www.example.com/ or example.com/blog/.", "default": [ "https://fastapi.tiangolo.com/" ], "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "audit", "sitemapOnly" ], "type": "string", "description": "Full audit downloads and checks every page. Sitemap URLs only lists the URLs in the website's sitemaps (with lastmod, changefreq and priority) without visiting the pages, at a much lower price.", "default": "audit" }, "maxPagesPerSite": { "title": "Maximum pages per website", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many pages (or sitemap URLs) per website.", "default": 50 }, "useSitemaps": { "title": "Find pages in sitemaps", "type": "boolean", "description": "Read the sitemaps listed in robots.txt, or /sitemap.xml, including sitemap index files and .gz sitemaps.", "default": true }, "crawlLinks": { "title": "Also follow internal links", "type": "boolean", "description": "Also discover pages by following links on audited pages (same website). Used automatically when sitemaps are switched off or list fewer than 10 pages. Full audit mode only.", "default": false }, "stayWithinStartPath": { "title": "Stay within the start URL's folder", "type": "boolean", "description": "Only include pages under the start URL's path, e.g. only /blog/ pages when you enter example.com/blog/.", "default": true }, "onlyPagesWithIssues": { "title": "Only save pages with issues", "type": "boolean", "description": "Skip pages where no issue was found. Skipped pages are not charged.", "default": false }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. Requests to each site are also spaced out politely, and any Crawl-delay in robots.txt is honoured.", "default": 5 } } }, "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 } } } } } } } } } }