{ "openapi": "3.0.1", "info": { "title": "SEO Audit & Broken Link Checker: Full Site Crawl", "description": "Crawl any website and get one row per page with its SEO issues: titles, meta descriptions, H1, noindex, canonical, hreflang, structured data, missing alt, broken links, redirects, duplicates and orphan pages. Monitor new and fixed issues. Respects robots.txt.", "version": "1.0", "x-build-id": "iIgdPbjqpe8ZgK1As" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digital_influx~seo-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digital_influx-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/digital_influx~seo-audit/runs": { "post": { "operationId": "runs-sync-digital_influx-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/digital_influx~seo-audit/run-sync": { "post": { "operationId": "run-sync-digital_influx-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": [ "websites" ], "properties": { "websites": { "title": "Websites", "type": "array", "description": "One per line: a domain (example.com) or the URL where the crawl starts. Each website is audited separately, following its internal links and its sitemap.", "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Pages audited per website (each one is charged). Pages found beyond this are counted in notCrawled.", "default": 100 }, "useSitemap": { "title": "Use the sitemap", "type": "boolean", "description": "Read the sitemaps listed in robots.txt (or /sitemap.xml) to find pages no link points to (orphan pages) and to mark which pages are in the sitemap.", "default": true }, "checkExternalLinks": { "title": "Check external links", "type": "boolean", "description": "Also check links that point to other websites (a HEAD request each). Internal links are always checked.", "default": true }, "maxExternalLinksPerSite": { "title": "Max external links to check per website", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Unique external links checked per website.", "default": 200 }, "compareWithPreviousRun": { "title": "Compare with the previous audit (monitoring)", "type": "boolean", "description": "For scheduled audits: every page row gets \"changes\" (issues that are new and issues that were fixed since the last audit of the site, and whether the page is new), and the site row sums it up, with the pages that disappeared. The last audit of each site is kept in a key-value store named \"seo-audit-state\" in your account.", "default": false }, "stateKey": { "title": "Memory name (optional)", "type": "string", "description": "Give a name to keep a separate history, for example one per client, or a new name to start over. Letters, digits, dot, dash and underscore." }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Recommended. Pages disallowed by robots.txt are not read (they are listed in the site summary), and external links on sites that disallow crawlers are not checked. Turn off only for your own website.", "default": true }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Requests to one website at the same time (1 to 10). Keep it low to be gentle with small servers.", "default": 3 } } }, "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 } } } } } } } } } }