{ "openapi": "3.0.1", "info": { "title": "Website Performance Auditor — Lighthouse & PageSpeed", "description": "Run Google Lighthouse performance audits via PageSpeed Insights API. Get performance, accessibility, SEO, and best-practices scores for any URL.", "version": "1.0", "x-build-id": "pHpkgjZ9LBqaKggmI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/perryay~website-performance-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-perryay-website-performance-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/perryay~website-performance-auditor/runs": { "post": { "operationId": "runs-sync-perryay-website-performance-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/perryay~website-performance-auditor/run-sync": { "post": { "operationId": "run-sync-perryay-website-performance-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": [ "url" ], "properties": { "mode": { "title": "Audit mode", "enum": [ "single", "batch", "scheduled", "compare", "trend" ], "type": "string", "description": "Operating mode: 'single' audits one URL, 'batch' audits multiple URLs concurrently, 'scheduled' audits and tracks history for trending, 'compare' compares two URL sets, 'trend' generates trend reports from stored history without new audits.", "default": "single" }, "url": { "title": "URL to audit", "type": "string", "description": "Website URL to audit. Used directly in 'single' mode. In 'batch' or 'scheduled' modes, use this field with newline-separated URLs, or use the 'urls' array field instead." }, "urls": { "title": "URLs (array)", "type": "array", "description": "List of website URLs to audit. Used in 'batch', 'scheduled', and 'trend' modes. Each URL is checked against PageSpeed Insights API concurrently (up to 10 at a time)." }, "urlsA": { "title": "URL set A (compare mode)", "type": "array", "description": "First set of URLs for comparison. Used in 'compare' mode to diff scores against URLs in 'urlsB'. Typically the baseline audit results." }, "urlsB": { "title": "URL set B (compare mode)", "type": "array", "description": "Second set of URLs for comparison. Used in 'compare' mode to diff scores against URLs in 'urlsA'. Typically the current audit results." }, "strategy": { "title": "Audit strategy", "enum": [ "mobile", "desktop" ], "type": "string", "description": "Lighthouse strategy: 'mobile' emulates a Moto G4 on slow 3G, 'desktop' emulates a desktop browser. Mobile scores are typically lower and more conservative.", "default": "mobile" }, "apiKey": { "title": "Google API Key", "type": "string", "description": "Optional Google API key for higher PageSpeed Insights API quota. Without a key, the API works but is subject to lower rate limits. Create a key at https://console.cloud.google.com/apis/credentials." }, "concurrency": { "title": "Concurrency limit", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of concurrent PageSpeed API requests in batch/scheduled/compare modes. Higher concurrency completes faster but may hit rate limits.", "default": 5 } } }, "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 } } } } } } } } } }