{ "openapi": "3.0.1", "info": { "title": "Website Lighthouse & WCAG Regression Report", "description": "Run Lighthouse and axe-core audits on authorized public websites, then generate performance, accessibility, SEO, and regression reports.", "version": "0.1", "x-build-id": "EYc274rhVRYzqSgC7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~website-lighthouse-accessibility-regression-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-website-lighthouse-accessibility-regression-report", "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/taroyamada~website-lighthouse-accessibility-regression-report/runs": { "post": { "operationId": "runs-sync-taroyamada-website-lighthouse-accessibility-regression-report", "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/taroyamada~website-lighthouse-accessibility-regression-report/run-sync": { "post": { "operationId": "run-sync-taroyamada-website-lighthouse-accessibility-regression-report", "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": "URLs", "type": "array", "description": "Authorized public HTTP(S) pages to audit.", "items": { "type": "string" }, "default": [ "https://example.com/" ] }, "sitemapUrl": { "title": "Sitemap URL", "type": "string", "description": "Optional public sitemap.xml. URLs are capped by maxPages.", "default": "" }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum unique pages audited in one run.", "default": 5 }, "strategy": { "title": "Lighthouse strategy", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Audit with mobile emulation, desktop settings, or both.", "default": "mobile" }, "runMode": { "title": "Run mode", "enum": [ "audit", "monitor" ], "type": "string", "description": "Audit returns current results; monitor stores a baseline and returns changes.", "default": "audit" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Stable private state namespace for a recurring monitor.", "default": "" }, "initialRunMode": { "title": "First monitor run", "enum": [ "baseline_only", "emit_backfill" ], "type": "string", "description": "Store a free baseline or emit the first observed audit rows.", "default": "baseline_only" }, "scoreDropThreshold": { "title": "Score drop alert threshold", "minimum": 1, "maximum": 50, "type": "number", "description": "Alert when a 0–100 Lighthouse category score falls by at least this amount.", "default": 5 }, "generateReport": { "title": "Generate site report", "type": "boolean", "description": "Create one multi-page report row when audit rows are emitted.", "default": true }, "generateExport": { "title": "Generate portfolio export", "type": "boolean", "description": "Create one full audit handoff export row.", "default": false }, "emitUnchanged": { "title": "Emit unchanged monitor rows", "type": "boolean", "description": "Keep false so unchanged monitor runs emit zero rows and zero charges.", "default": false }, "authorizedUseConfirmed": { "title": "I am authorized to audit these URLs", "type": "boolean", "description": "Required for live runs. Use only sites you own, operate, or are authorized to test.", "default": false }, "maxChargeUsd": { "title": "Maximum Actor charge", "minimum": 0, "maximum": 1000, "type": "number", "description": "Optional Actor-side spending cap; zero uses only the Apify run limit.", "default": 0 }, "timeoutMs": { "title": "Per-page timeout", "minimum": 30000, "maximum": 180000, "type": "integer", "description": "Maximum Lighthouse execution time per page and strategy.", "default": 90000 }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Return illustrative rows without fetching pages or charging events.", "default": true } } }, "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 } } }, "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 } } } } } } } } } }