{ "openapi": "3.0.1", "info": { "title": "Technical SEO Audit & Website Crawler - Core Web Vitals", "description": "Crawl websites and detect technical SEO issues across metadata, indexability, headings, content, links, images, structured data, security headers, and optional PageSpeed Core Web Vitals.", "version": "1.0", "x-build-id": "iTT4VagugMZRcLfe8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groupoject~technical-seo-audit-crawler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groupoject-technical-seo-audit-crawler", "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/groupoject~technical-seo-audit-crawler/runs": { "post": { "operationId": "runs-sync-groupoject-technical-seo-audit-crawler", "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/groupoject~technical-seo-audit-crawler/run-sync": { "post": { "operationId": "run-sync-groupoject-technical-seo-audit-crawler", "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": { "startUrls": { "title": "Websites to audit", "type": "array", "description": "Start pages or domains. The crawler follows internal links from each URL.", "items": { "type": "string" } }, "urlsText": { "title": "URLs as text", "type": "string", "description": "Paste one website URL per line." }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum pages to crawl and bill across all websites.", "default": 25 }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "Start URLs are depth 0. Set 0 to audit only the supplied pages.", "default": 3 }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Allow links on subdomains of each starting hostname.", "default": false }, "includePatterns": { "title": "Include URL patterns", "type": "array", "description": "Optional wildcard patterns. Only matching crawl URLs are included, for example https://example.com/blog/*.", "items": { "type": "string" } }, "excludePatterns": { "title": "Exclude URL patterns", "type": "array", "description": "Wildcard patterns to skip, such as */login*, */cart*, or *?preview=*.", "items": { "type": "string" } }, "checkBrokenLinks": { "title": "Check broken links", "type": "boolean", "description": "Send extra HEAD/GET requests to test discovered links. This increases runtime.", "default": false }, "maxLinksToCheck": { "title": "Maximum links to check", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique internal and external links tested when broken-link checks are enabled.", "default": 100 }, "includePageSpeed": { "title": "Run PageSpeed and Core Web Vitals", "type": "boolean", "description": "Call Google PageSpeed Insights for a limited number of crawled pages.", "default": false }, "pageSpeedStrategy": { "title": "PageSpeed strategy", "enum": [ "mobile", "desktop" ], "type": "string", "description": "Mobile is recommended for SEO audits.", "default": "mobile" }, "pageSpeedApiKey": { "title": "Google PageSpeed API key", "type": "string", "description": "Optional. Improves PageSpeed quota and reliability. The key is never included in output." }, "pageSpeedMaxPages": { "title": "Maximum PageSpeed pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Limit expensive PageSpeed calls separately from the crawl page limit.", "default": 3 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Concurrent page requests. Lower this for small or sensitive websites.", "default": 10 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time to wait for each page request before retrying or recording a crawl failure.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Direct requests are usually enough for public websites." }, "userAgent": { "title": "Custom user agent", "type": "string", "description": "Optional HTTP user-agent override." }, "debugMode": { "title": "Debug mode", "type": "boolean", "description": "Enable verbose crawler logs.", "default": false } } }, "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 } } } } } } } } } }