{ "openapi": "3.0.1", "info": { "title": "SEO Audit & Broken Link Checker: Technical SEO", "description": "SEO audit tool and site audit crawler with a 0 to 100 SEO score per page and per site. Works as a broken link checker, 404 checker and redirect checker. Checks titles, meta descriptions, H1s, canonicals, noindex, hreflang, sitemap and robots.txt. One row per page with issue codes.", "version": "0.1", "x-build-id": "kx8BELct0cCC9MbSf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~technical-seo-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-technical-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/maliksaid~technical-seo-audit/runs": { "post": { "operationId": "runs-sync-maliksaid-technical-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/maliksaid~technical-seo-audit/run-sync": { "post": { "operationId": "run-sync-maliksaid-technical-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": "Start URLs", "type": "array", "description": "Pages where the audit starts. The Actor follows links to other pages on the same site. Audit only sites you own or have permission to audit.", "default": [ { "url": "https://books.toscrape.com/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum pages", "minimum": 0, "type": "integer", "description": "Stop after saving this many pages. The default keeps test runs short and cheap. Set 0 for no limit.", "default": 100 }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Also crawl subdomains of the start URLs, for example blog.example.com. The www. prefix always counts as the same site.", "default": false }, "crawlLinks": { "title": "Follow links to other pages", "type": "boolean", "description": "On: audit the start URLs and the pages they link to on the same site. Off: audit only the start URLs, for example a list of landing pages. Links on those pages are still checked for errors.", "default": true }, "excludeUrlPatterns": { "title": "Skip URLs matching", "type": "array", "description": "Pages whose URL matches one of these patterns are not crawled, saved or charged. ** matches any text, * matches text within one path segment. Example: **/tag/** or **?filter=*", "default": [], "items": { "type": "string" } }, "checkLinks": { "title": "Check links for errors", "type": "boolean", "description": "Check every link found on each page once per run. Links that return status 400 or higher, or fail to load, are reported as broken.", "default": true }, "checkExternalLinks": { "title": "Check links to other sites", "type": "boolean", "description": "Also check links that point to other websites. Turn off to check only links inside your site.", "default": true }, "checkSitemap": { "title": "Check robots.txt and XML sitemap", "type": "boolean", "description": "Read robots.txt and the XML sitemaps it lists (or /sitemap.xml). Flags pages missing from the sitemap, sitemap URLs that redirect, fail or are noindex, and sitemap URLs no crawled page links to.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages the Actor loads at the same time. Keep it low for small servers.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Most sites need no proxy. Use one only if your site blocks data-centre traffic.", "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 } } } } } } } } } }