{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker & SEO Site Audit: WCAG, Redirects, SSL", "description": "Crawl your website to find broken links, redirect chains and loops, missing SEO basics (title, meta description, H1, canonical, Open Graph, hreflang), WCAG accessibility issues (axe-core) and SSL expiry. Get a prioritised fix list, CSV and client-ready PDF report. Respects robots.txt.", "version": "0.2", "x-build-id": "XPI7noXpajiSSwB9z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jordydev~site-qa-crawler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jordydev-site-qa-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/jordydev~site-qa-crawler/runs": { "post": { "operationId": "runs-sync-jordydev-site-qa-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/jordydev~site-qa-crawler/run-sync": { "post": { "operationId": "run-sync-jordydev-site-qa-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", "required": [ "startUrl" ], "properties": { "startUrl": { "title": "Start URL", "type": "string", "description": "The site to crawl. Crawl only sites you own or have permission to test. robots.txt is always respected; private and internal addresses are never fetched." }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many pages. Each fetched page is one 'page-crawled' event ($0.004).", "default": 50 }, "maxDepth": { "title": "Max depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many links deep to follow. 0 = the start URL only (no sitemap). Sitemap pages count as depth 1.", "default": 5 }, "includePatterns": { "title": "Include patterns", "type": "array", "description": "Only crawl URLs matching one of these globs, e.g. https://example.com/blog/**. ** matches anything, * anything except '/'.", "default": [], "items": { "type": "string" } }, "excludePatterns": { "title": "Exclude patterns", "type": "array", "description": "Skip URLs matching these globs (they can still be link-checked).", "default": [ "**/wp-admin/**", "**/cart/**", "**/checkout/**" ], "items": { "type": "string" } }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links to other sites (HEAD, GET fallback). External sites are never crawled, and their robots.txt is respected.", "default": true }, "maxLinkChecks": { "title": "Max link checks", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Cap on unique links checked that were not crawled as pages. Link checks are included in the page price.", "default": 1000 }, "wcagLevel": { "title": "WCAG level", "enum": [ "off", "A", "AA" ], "type": "string", "description": "Run axe-core in Chromium on every HTML page. One extra 'wcag-check' event ($0.02) per page checked.", "default": "off" }, "checkSsl": { "title": "Check SSL certificate", "type": "boolean", "description": "Read the start host's TLS certificate (expiry, issuer, trust). One 'ssl-check' event ($0.002) only when a certificate was read.", "default": true }, "requestsPerSecond": { "title": "Requests per second (per host)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Politeness limit applied to every request: pages, link checks, robots.txt, sitemaps and same-host browser requests. Keep it low on sites you do not control.", "default": 2 }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Treat subdomains of the start host (e.g. blog.example.com) as part of the site.", "default": false }, "useSitemap": { "title": "Use sitemap", "type": "boolean", "description": "Seed the crawl from robots.txt Sitemap: lines, /sitemap.xml and /sitemap_index.xml (same-site URLs only).", "default": true }, "saveCsv": { "title": "Save CSV", "type": "boolean", "description": "Save site-qa.csv (pages) and fixes.csv to the key-value store.", "default": true }, "savePdf": { "title": "Save PDF report", "type": "boolean", "description": "Save a client-ready site-qa-report.pdf to the key-value store.", "default": true } } }, "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 } } } } } } } } } }