{ "openapi": "3.0.1", "info": { "title": "Technical SEO Audit Tool", "description": "Review technical SEO signals across a website or a supplied set of URLs. Each HTML page record includes titles, headings, canonicals, indexability directives, redirect details, links, image alt gaps, schema types and rule-based issue codes. Uses plain HTTP without a browser or API key.", "version": "0.1", "x-build-id": "XtBXSgJ0D5mRAycOn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~website-seo-audit-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-website-seo-audit-tool", "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/axiomworks~website-seo-audit-tool/runs": { "post": { "operationId": "runs-sync-axiomworks-website-seo-audit-tool", "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/axiomworks~website-seo-audit-tool/run-sync": { "post": { "operationId": "run-sync-axiomworks-website-seo-audit-tool", "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": "Start URLs", "type": "array", "description": "Websites or pages to audit, as [{\"url\": \"https://www.example.com/\"}] or plain strings. Full URLs or bare hosts ('python.org', https:// is added). Each start URL defines its site: links to the same host (www. ignored) are internal. A dead host gives no record and is named in the status message; a page that answers 404 is audited with statusCode 404. Also accepted as the keys url, urls or startUrl." }, "maxDepth": { "title": "Crawl depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many link levels to follow from each start URL, 0-10, default 1. 0 audits only the given URLs (URL-list mode); 1 adds the internal pages they link to; 2 the pages those link to, and so on. Only internal links of pages that answered 200 are followed.", "default": 1 }, "maxPages": { "title": "Maximum pages to fetch", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of pages fetched across all start URLs, 1-10000, default 50. Counts every fetch, including non-HTML responses and pages that gave no response, so it bounds run time.", "default": 50 }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of page records to return across all start URLs, 1-100000, default 50. The run stops as soon as this many records are saved, and you are charged only for records returned.", "default": 50 }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Default false. When true, blog.example.com counts as internal to example.com: it is crawled and counted in internalLinksCount. When false, subdomain links count as external.", "default": false }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Default false. When true, internal links that the site's robots.txt disallows for User-agent: * are not crawled (start URLs are always fetched). The robotsTxtDisallowed field is reported for every page either way.", "default": false }, "excludeUrlPatterns": { "title": "Exclude URL patterns", "type": "array", "description": "Regular expressions (case-insensitive), one per line; internal links matching any of them are not crawled, e.g. '/wp-admin/' or '\\?page='. Default: none. Start URLs are always audited.", "default": [], "items": { "type": "string" } }, "maxRedirects": { "title": "Maximum redirects", "minimum": 0, "maximum": 30, "type": "integer", "description": "Redirect hops to follow per page, 0-30, default 10. A page that redirects more often gives no record and is listed in the SUMMARY record's pageErrors.", "default": 10 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Seconds to wait for each response, 3-120, default 15. A page that times out twice gives no record and is listed in the SUMMARY record's pageErrors.", "default": 15 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages fetched in parallel, 1-20, default 3. At most 2 requests run at once per host, 300-600 ms apart, so a single site is crawled politely whatever this is set to.", "default": 3 }, "userAgent": { "title": "User-Agent", "type": "string", "description": "User-Agent header to send, e.g. to audit what a specific client sees. Leave empty for the default desktop Chrome User-Agent." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for all requests, default none (direct). Without a proxy, a start page that answers 403/429/503 is retried once through Apify Proxy datacenter, then residential; other blocked pages are recorded with their status. Pick a proxy here to send every request through it.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }