{ "openapi": "3.0.1", "info": { "title": "Website Audit Monitor: Lighthouse + Accessibility", "description": "Lighthouse performance, SEO, best-practices and accessibility scores, lab Core Web Vitals, top fixes with estimated savings, and an axe-core WCAG scan for your URLs. Monitor mode stores each run and reports score drops, new failing audits and new accessibility violations.", "version": "0.1", "x-build-id": "xLrHMPbh2W4PwDdlh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/singgendarhan~website-audit-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-singgendarhan-website-audit-monitor", "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/singgendarhan~website-audit-monitor/runs": { "post": { "operationId": "runs-sync-singgendarhan-website-audit-monitor", "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/singgendarhan~website-audit-monitor/run-sync": { "post": { "operationId": "run-sync-singgendarhan-website-audit-monitor", "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": [ "urls" ], "properties": { "urls": { "title": "URLs to audit", "type": "array", "description": "One page URL per line (http or https). Each URL is loaded once per selected device; links on the page are not followed. 'https://' is added when missing. Up to 500 URLs per run. Only audit sites you own or have permission to test.", "items": { "type": "string" } }, "formFactors": { "title": "Devices", "type": "array", "description": "Mobile uses Lighthouse's default mobile emulation (moto g power, simulated slow 4G, 4x CPU slowdown), like PageSpeed Insights. Desktop uses Lighthouse's desktop preset. Each device is a separate audit (and a separate charge).", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Categories to score. Fewer categories make each audit a little faster; the price is the same.", "items": { "type": "string", "enum": [ "performance", "seo", "best-practices", "accessibility" ], "enumTitles": [ "Performance", "SEO", "Best practices", "Accessibility" ] }, "default": [ "performance", "seo", "best-practices", "accessibility" ] }, "monitorName": { "title": "Monitor name (turns on change tracking)", "pattern": "^[A-Za-z0-9 _-]{0,40}$", "type": "string", "description": "Give your monitor a name (for example 'client-acme') and schedule this Actor. Each run is compared with the previous run of the same monitor: score drops and rises, slower lab metrics, newly failing audits, new or resolved axe violations, and pages that stopped loading. Results are kept in a named key-value store 'website-audit-monitor-' in your account. Letters, digits and hyphens." }, "performanceChangeThreshold": { "title": "Performance score change threshold (points)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Report a performance score change only when it moves by at least this many points (0-100). Lab performance scores vary between identical runs, typically a few points; 10 keeps scheduled change logs clean.", "default": 10 }, "scoreChangeThreshold": { "title": "Accessibility / SEO / best-practices change threshold (points)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Report an accessibility, SEO or best-practices score change only when it moves by at least this many points. These scores are stable between runs, so a change usually means the page changed.", "default": 5 }, "metricChangeThresholdPct": { "title": "Lab metric change threshold (%)", "minimum": 5, "maximum": 500, "type": "integer", "description": "Report LCP, FCP, Speed Index, TBT or CLS changes only when they change by at least this percentage and by a minimum absolute amount (LCP/SI 500 ms, FCP 300 ms, TBT 200 ms, CLS 0.05).", "default": 25 }, "axeScan": { "title": "Run axe-core accessibility scan", "type": "boolean", "description": "Run the full axe-core rule set on the page Lighthouse loaded (no extra page load) and list violations by rule with element counts, WCAG criteria, help links and example selectors.", "default": true }, "axeStandard": { "title": "WCAG rule set", "enum": [ "wcag22aa", "wcag21aa", "wcag2aa", "wcag2a" ], "type": "string", "description": "Which WCAG level-A and AA rules axe-core runs.", "default": "wcag22aa" }, "axeBestPractices": { "title": "Include axe best-practice rules", "type": "boolean", "description": "Also run axe-core's best-practice rules (landmarks, heading order and similar). They are marked bestPractice: true and are not WCAG failures.", "default": true }, "maxIssuesPerUrl": { "title": "Top issues per URL", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many failing Lighthouse audits and performance opportunities to list per URL, ranked by estimated time savings and Lighthouse weight.", "default": 10 }, "maxAxeExamples": { "title": "Example selectors per axe rule", "minimum": 1, "maximum": 10, "type": "integer", "description": "CSS selectors of affected elements to include for each axe-core rule.", "default": 3 }, "saveHtmlReport": { "title": "Save HTML summary report", "type": "boolean", "description": "Save REPORT.html (scores, Core Web Vitals, top fixes, axe violations and the change log) to the run's key-value store.", "default": true }, "saveLighthouseReports": { "title": "Save full Lighthouse HTML report per URL", "type": "boolean", "description": "Also save Lighthouse's own HTML report for every audit (about 0.5-1 MB each) and link it from the dataset row.", "default": false }, "maxConcurrency": { "title": "Parallel audits", "minimum": 1, "maximum": 4, "type": "integer", "description": "Audits running at the same time. Lighthouse is CPU-heavy and parallel audits compete for CPU, which lowers performance scores; keep 1 for the most stable scores. Each parallel audit needs about 2 GB of run memory (it is lowered automatically if memory is too small).", "default": 1 }, "perUrlTimeoutSecs": { "title": "Timeout per URL", "minimum": 30, "maximum": 600, "type": "integer", "description": "Maximum time for one audit attempt (browser start, Lighthouse, axe-core). Pages that do not finish are reported with errorCode PAGE_TIMEOUT and are not charged.", "default": 90 }, "maxRetries": { "title": "Retries for failed audits", "minimum": 0, "maximum": 2, "type": "integer", "description": "Extra attempts for temporary failures (timeouts, connection errors, HTTP 5xx, browser crashes). DNS failures, HTTP 4xx, invalid certificates and non-HTML URLs are not retried.", "default": 1 } } }, "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 } } } } } } } } } }