{ "openapi": "3.0.1", "info": { "title": "Website Audit: PageSpeed, Core Web Vitals & WCAG Accessibility", "description": "Audit every page of a sitemap or URL list in one run: Google PageSpeed Insights Lighthouse scores and real-user Core Web Vitals, plus a full WCAG 2.2 accessibility audit (axe-core) listing each failing element, its fix and EN 301 549 clause. Client-ready PDF report.", "version": "0.1", "x-build-id": "T7nkMMXzDj5XqF8jF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/iiclabs~site-audit-pagespeed-wcag/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-iiclabs-site-audit-pagespeed-wcag", "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/iiclabs~site-audit-pagespeed-wcag/runs": { "post": { "operationId": "runs-sync-iiclabs-site-audit-pagespeed-wcag", "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/iiclabs~site-audit-pagespeed-wcag/run-sync": { "post": { "operationId": "run-sync-iiclabs-site-audit-pagespeed-wcag", "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", "properties": { "urls": { "title": "Pages", "type": "array", "description": "Page URLs to audit (http or https). Add a sitemap below to audit a whole site.", "items": { "type": "string" } }, "sitemaps": { "title": "Sitemaps", "type": "array", "description": "Sitemap URLs (sitemap.xml, a sitemap index or .xml.gz). Their pages are added after the ones above, up to the maximum.", "items": { "type": "string" } }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Stop after this many pages (you pay per page audited).", "default": 50 }, "speed": { "title": "Speed: PageSpeed Insights and Core Web Vitals", "type": "boolean", "description": "Google Lighthouse scores (performance, accessibility, best practices, SEO), lab timings and real-user Core Web Vitals (LCP, INP, CLS) from Google's PageSpeed Insights API.", "default": true }, "strategy": { "title": "Device", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Which Lighthouse run to request for speed. Both doubles the PageSpeed calls but not the price.", "default": "mobile" }, "accessibility": { "title": "Accessibility: full WCAG audit", "type": "boolean", "description": "Runs axe-core in Chrome on each page and lists every failing element with the rule, the fix, its WCAG success criteria and EN 301 549 clauses.", "default": true }, "standard": { "title": "WCAG version", "enum": [ "wcag22aa", "wcag21aa", "wcag2aa" ], "type": "string", "description": "Rules to check, at level A and AA.", "default": "wcag22aa" }, "bestPractices": { "title": "Include axe best practices", "type": "boolean", "description": "Also report axe-core's best-practice rules, which are not WCAG requirements.", "default": false }, "maxElementsPerIssue": { "title": "Elements listed per issue", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many failing elements each issue lists in the dataset (counts always include all).", "default": 10 }, "pdfReport": { "title": "PDF report", "type": "boolean", "description": "Also save the run's report as REPORT.pdf (charged once per run). The HTML report (REPORT) is always saved.", "default": true }, "reportTitle": { "title": "Report title", "type": "string", "description": "Replaces the default title (\"Site audit: example.com\") on the report. For client reports." }, "brandName": { "title": "Your brand name", "type": "string", "description": "Shown at the top of the report, so you can hand it to clients as your own." }, "logoUrl": { "title": "Your logo (public https image link)", "type": "string", "description": "A link to your logo (PNG, JPG, SVG or WebP) shown at the top of the report." }, "hideBranding": { "title": "Remove the \"Made with Website Audit\" line", "type": "boolean", "description": "White-label report: leaves out our credit line. No extra charge.", "default": false }, "compareWithPrevious": { "title": "Compare with the previous audit", "type": "boolean", "description": "Remembers each page's last audit in your own Apify storage and reports what is new and what was fixed since then, plus performance score changes. Use it on a schedule to track progress. The first run becomes the baseline.", "default": false }, "historyName": { "title": "History name", "type": "string", "description": "Separate history per site or client. Only used with \"Compare with the previous audit\".", "default": "default" }, "pageSpeedApiKey": { "title": "Your PageSpeed Insights API key (optional)", "type": "string", "description": "Only needed for very large audits, or to audit more than 10 pages per run on the free Apify plan: speed checks use our key by default. A key is free from Google Cloud (PageSpeed Insights API)." } } }, "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 } } } } } } } } } }