{ "openapi": "3.0.1", "info": { "title": "Website SEO Audit & Broken Links — Agency Reports", "description": "Agency SEO audits with branded HTML/PDF reports, grouped fix queues, priority landing-page checks, broken links, sitemap discovery, and reliable regression tracking. Export JSON and CSV.", "version": "1.2", "x-build-id": "6SfeeuCBqolcmJSuf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fascinating_lentil~website-health-seo-broken-link-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fascinating_lentil-website-health-seo-broken-link-auditor", "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/fascinating_lentil~website-health-seo-broken-link-auditor/runs": { "post": { "operationId": "runs-sync-fascinating_lentil-website-health-seo-broken-link-auditor", "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/fascinating_lentil~website-health-seo-broken-link-auditor/run-sync": { "post": { "operationId": "run-sync-fascinating_lentil-website-health-seo-broken-link-auditor", "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", "confirmAuthorizedUse" ], "properties": { "startUrl": { "title": "Start URL", "type": "string", "description": "The initial URL to start auditing. Must be HTTP or HTTPS." }, "confirmAuthorizedUse": { "title": "Confirm Authorized Use", "type": "boolean", "description": "I confirm that I own or have explicit authorization to audit the target website. Checking this box confirms existing authorization; it does not create permission. Mandatory for all domains except example.com.", "default": false }, "maxPages": { "title": "Maximum Pages to Audit", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of internal pages to crawl and audit (default 25, hard max 250).", "default": 25 }, "maxCrawlDepth": { "title": "Maximum Crawl Depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum link click depth from startUrl (default 3, max 10).", "default": 3 }, "maxLinksPerPage": { "title": "Maximum Links per Page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of links extracted and queued per page (default 100, max 500).", "default": 100 }, "checkExternalLinks": { "title": "Check External Links", "type": "boolean", "description": "Check status of external links (checked via HEAD/GET once, never recursively crawled).", "default": false }, "maxExternalLinks": { "title": "Maximum External Links to Check", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Maximum total unique external links to check across the entire audit (default 250, max 2000).", "default": 250 }, "maxInternalLinks": { "title": "Maximum additional internal link checks", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Cap unique internal targets checked beyond pages already crawled. Default 200; zero checks only already-crawled targets. Unchecked links are disclosed in report coverage.", "default": 200 }, "crawlMode": { "title": "Audit mode", "enum": [ "website", "url_list" ], "type": "string", "description": "Website mode follows internal links. URL list mode audits only startUrl and priorityUrls; bounded link status checks can still run.", "default": "website" }, "priorityUrls": { "title": "Priority client landing pages", "maxItems": 50, "type": "array", "description": "Up to 50 absolute URLs in the authorized starting domain. These pages are queued ahead of discovered links and influence fix ordering. The maximum-pages budget still applies.", "items": { "type": "string" } }, "crawlSitemap": { "title": "Include pages discovered in sitemaps", "type": "boolean", "description": "In website mode, queue sitemap URLs after selected priority pages, before link discovery. Helps inspect unlinked pages within the same page and robots limits.", "default": false }, "agencyName": { "title": "Agency name on reports", "maxLength": 100, "type": "string", "description": "Your agency name for client-facing HTML and US Letter PDF reports. Plain text, up to 100 characters." }, "clientName": { "title": "Client or campaign name", "maxLength": 100, "type": "string", "description": "Report title for this client, website, or campaign. Plain text, up to 100 characters." }, "brandColor": { "title": "Agency accent color", "pattern": "^#[a-fA-F0-9]{6}$", "type": "string", "description": "Optional HTML report accent in #RRGGBB format, for example #2563eb. Invalid colors fall back to blue." }, "includePerformance": { "title": "Include PageSpeed Performance", "type": "boolean", "description": "Whether to fetch PageSpeed Insights data for top pages (disabled by default).", "default": false }, "pageSpeedApiKey": { "title": "Google PageSpeed API Key", "type": "string", "description": "Optional user-provided API key for Google PageSpeed Insights. Never logged or stored in output." }, "maxPerformancePages": { "title": "Maximum Performance Pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of pages to run through PageSpeed Insights (default 1, max 5).", "default": 1 }, "compareWithPreviousRun": { "title": "Compare with Previous Run (Baseline Tracking)", "type": "boolean", "description": "Compare current findings against persistent baseline to identify new, resolved, and materially changed issues.", "default": true }, "baselineKey": { "title": "Custom Baseline Key", "maxLength": 48, "type": "string", "description": "Optional custom key-value store key name for baseline storage. If omitted, derived from target domain." }, "generateHtmlReport": { "title": "Generate HTML Report", "type": "boolean", "description": "Generate a self-contained branded client report with grouped fix priorities and explicit audit coverage.", "default": true }, "generatePdfReport": { "title": "Generate PDF Report", "type": "boolean", "description": "Generate a downloadable PDF audit report saved in the Key-Value Store.", "default": false }, "generateCsvReport": { "title": "Generate Spreadsheet-Ready CSV Report", "type": "boolean", "description": "Generate a formula-safe CSV file containing every prioritized issue, its evidence, and the recommended fix.", "default": true }, "failOnSeverity": { "title": "Fail Run on Issue Severity Threshold", "enum": [ "none", "error", "critical" ], "type": "string", "description": "If set, the run will exit with failure (ciPassed=false) if any issue meets or exceeds this severity.", "default": "none" } } }, "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 } } } } } } } } } }