{ "openapi": "3.0.1", "info": { "title": "SEO Audit Tool: Bulk Website Audit with Scores & Fixes", "description": "Run a website SEO audit on a whole site from its sitemap, or any list of URLs: 0-100 SEO score per page, a site summary with the top 5 fixes ranked by impact, duplicate titles, broken pages and a client-ready HTML report. $2 per 1,000 pages, failures free.", "version": "0.1", "x-build-id": "fDv45OLfLu3Cj8S19" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hillcountrybots~seo-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hillcountrybots-seo-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/hillcountrybots~seo-audit/runs": { "post": { "operationId": "runs-sync-hillcountrybots-seo-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/hillcountrybots~seo-audit/run-sync": { "post": { "operationId": "run-sync-hillcountrybots-seo-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Websites, sitemaps or page URLs", "type": "array", "description": "Required. One per line. A homepage or bare domain (example.com) = whole-site audit. A sitemap URL (…/sitemap.xml) = audit the pages it lists. Any other URL = audit just that page. Private, local and internal addresses and login/account/admin/cart/checkout pages are refused for free.", "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "type": "integer", "description": "Pages audited per website or sitemap (shallow, important pages first). 10 for a quick preview, 100 for a standard audit, 1,000+ for a deep one. Single page URLs you list yourself are not limited by this.", "default": 100 }, "maxPages": { "title": "Max pages in this run (spend cap)", "minimum": 1, "type": "integer", "description": "Total pages audited and charged in this run. Caps spend at maxPages x $0.002 (1,000 = $2). Failed pages do not count. The run's own max-charge setting is also respected.", "default": 1000 }, "auditWholeSite": { "title": "Audit the whole site when I give a homepage", "type": "boolean", "description": "On: a homepage or bare domain expands to the site's pages (sitemap, or link crawl if no sitemap). Off: only the homepage itself is audited.", "default": true }, "includePatterns": { "title": "Only audit URLs matching", "type": "array", "description": "Optional globs (e.g. */blog/*) or /regex/. Applied to pages from sitemaps and link crawls.", "default": [], "items": { "type": "string" } }, "excludePatterns": { "title": "Skip URLs matching", "type": "array", "description": "Optional globs or /regex/, e.g. */tag/* or */page/*.", "default": [], "items": { "type": "string" } }, "checkBrokenLinks": { "title": "Check links for broken targets", "type": "boolean", "description": "Check the links on each page: links in the main content first, up to 'Links checked per page' new links per page (each unique link is checked once per run, HEAD first; links already checked are reported for free) and flag 404/410/5xx and dead domains. Included in the page price. Turn off for faster runs.", "default": true }, "maxLinksPerPage": { "title": "Links checked per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only used when the broken-link check is on (1-100).", "default": 20 }, "htmlReport": { "title": "Create the HTML report", "type": "boolean", "description": "Save a clean, shareable HTML report (scores, top fixes, duplicates, every page) to the key-value store as REPORT. Free.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip (free) pages that the site's robots.txt disallows for our crawler or all crawlers. Turn off only for sites you own or are allowed to audit.", "default": true }, "maxConcurrency": { "title": "Concurrency (all sites)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Pages fetched in parallel across all sites (1-50).", "default": 10 }, "maxConcurrencyPerSite": { "title": "Concurrency per site", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages fetched in parallel from one website (1-10). Keep low to be polite to small sites.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Seconds to wait for one page, including redirects (one retry on timeouts, network errors, 429 and 5xx).", "default": 20 } } }, "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 } } } } } } } } } }