{ "openapi": "3.0.1", "info": { "title": "SEO Audit & Broken Link Checker – Site Crawler", "description": "Crawl a site over HTTP: find broken links, redirect chains and on-page SEO issues. 0-100 score per page and what changed since the last run.", "version": "0.1", "x-build-id": "vRYNkzyHfmi6CAYpF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/far003~broken-link-seo-site-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-far003-broken-link-seo-site-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/far003~broken-link-seo-site-audit/runs": { "post": { "operationId": "runs-sync-far003-broken-link-seo-site-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/far003~broken-link-seo-site-audit/run-sync": { "post": { "operationId": "run-sync-far003-broken-link-seo-site-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": "Sites or URLs", "type": "array", "description": "Crawl mode: one entry per site to audit (example.com or https://example.com/blog/). List mode: the exact URLs to audit. A bare domain gets https://.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "crawl", "list" ], "type": "string", "description": "Crawl follows internal links (and the sitemap) from each start URL. List audits exactly the URLs you give, one record each, without following links.", "default": "crawl" }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Crawl mode: the crawl stops after this many pages per site, so this is also your cost cap (one page audit = one charged event). List mode audits every URL you give.", "default": 200 }, "checkExternalLinks": { "title": "Check links to other sites", "type": "boolean", "description": "Verify every link that leaves the site (one HEAD/GET per unique URL, never more than 1 request per second per host).", "default": true }, "checkResources": { "title": "Check images, scripts, stylesheets, iframes", "type": "boolean", "description": "Verify that every resource URL referenced by the page loads.", "default": true }, "useSitemap": { "title": "Read the sitemap", "type": "boolean", "description": "Crawl mode: reads the sitemaps declared in robots.txt (or /sitemap.xml), audits pages no link reaches (orphans) and flags sitemap contradictions.", "default": true }, "trackChanges": { "title": "Report what changed since the last run", "type": "boolean", "description": "Remembers each page's issues and broken links in a named key-value store and adds changeStatus, newIssueCodes, resolvedIssueCodes, newBrokenLinks and fixedBrokenLinks to every record. The first run is the baseline.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Runs with the same name share one memory. Use different names for independent schedules on the same site.", "default": "default" }, "maxDepth": { "title": "Max crawl depth", "minimum": 0, "maximum": 100, "type": "integer", "description": "Clicks from the start URL. 0 audits only the start URL: its links are still verified, sitemap pages are not audited.", "default": 20 }, "maxLinksPerPage": { "title": "Max links checked per page", "minimum": 10, "maximum": 5000, "type": "integer", "description": "Links beyond this number on a single page are counted as skipped.", "default": 500 }, "stayInStartFolder": { "title": "Stay in the start folder", "type": "boolean", "description": "On: an audit started at example.com/blog/ audits only pages under /blog/ (links elsewhere are still checked, not audited or charged). Off: the whole site is crawled from that page. A start URL at the root always means the whole site.", "default": true }, "includeSubdomains": { "title": "Treat subdomains as part of the site", "type": "boolean", "description": "Off: blog.example.com is an external site when auditing example.com (www is always the same site).", "default": false }, "excludeUrlPatterns": { "title": "Exclude URLs", "type": "array", "description": "URLs containing one of these texts are neither crawled nor checked. * is a wildcard, e.g. */tag/* or ?replytocom=", "items": { "type": "string" } }, "maxRequestsPerSecond": { "title": "Requests per second to the audited site", "minimum": 1, "maximum": 5, "type": "integer", "description": "1-5. Speed of the audit: a site with 1,000 unique internal URLs takes about 8 minutes at 2 per second. Raise it only on your own site. A Crawl-delay in robots.txt always wins; other sites are never asked more than once per second.", "default": 2 }, "timeoutSecs": { "title": "Timeout per request (seconds)", "minimum": 3, "maximum": 60, "type": "integer", "description": "3-60. Link checks use at most 10 seconds.", "default": 15 } } }, "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 } } } } } } } } } }