{ "openapi": "3.0.1", "info": { "title": "Chrome UX Report: Core Web Vitals Lookup by Origin", "description": "Real-user Core Web Vitals for any site from the Chrome UX Report API: LCP, INP and CLS at the 75th percentile, good/poor shares, by device. Bring your own free Google API key. Check a prospect list, benchmark competitors, export to Sheets.", "version": "1.0", "x-build-id": "sGnoNl42hPnWvya2Q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~crux-core-web-vitals-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-crux-core-web-vitals-lookup", "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/accountable_eel~crux-core-web-vitals-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-crux-core-web-vitals-lookup", "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/accountable_eel~crux-core-web-vitals-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-crux-core-web-vitals-lookup", "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": { "origins": { "title": "Origins or page URLs to check", "type": "array", "description": "One per line. A bare domain or origin (\"nytimes.com\", \"https://www.nytimes.com\") returns the whole site's real-user Core Web Vitals; a full page URL (\"https://web.dev/articles/vitals\") returns that single page's, when Google has enough traffic on it. Accepted formats: nytimes.com (domain, checked as the origin https://nytimes.com), https://www.nytimes.com (origin), https://web.dev/articles/vitals (one page; needs enough Chrome traffic). You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "apiKey": { "title": "Your free Google API key (needed for results)", "type": "string", "description": "Google only answers Chrome UX Report requests that carry an API key, and this actor never ships or shares one. Get your own free key in a few minutes: open console.cloud.google.com, create or pick a project, enable the \"Chrome UX Report API\" under APIs & Services, then create an API key under Credentials. No billing is needed, and the quota (150 queries per minute) is yours alone. Without a key every row comes back as NEEDS_KEY and nothing is fetched or charged. The key is masked, used only for the requests of this run, and never written to the output." }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "scope", "formFactor", "passesCoreWebVitals", "lcpP75Ms", "lcpRating", "lcpGoodShare", "lcpNeedsImprovementShare", "lcpPoorShare", "inpP75Ms", "inpRating", "inpGoodShare", "inpNeedsImprovementShare", "inpPoorShare", "clsP75", "clsRating", "clsGoodShare", "clsNeedsImprovementShare", "clsPoorShare", "fcpP75Ms", "ttfbP75Ms", "collectionPeriodStart", "collectionPeriodEnd", "source", "sourceUrl" ], "enumTitles": [ "Looked up as (origin or url)", "Device (ALL, PHONE, DESKTOP, TABLET)", "Passes Core Web Vitals (LCP, INP and CLS all good at p75)", "Largest Contentful Paint p75 (ms)", "LCP rating (good, needs-improvement, poor)", "LCP good share of visits (0-1)", "LCP needs-improvement share (0-1)", "LCP poor share (0-1)", "Interaction to Next Paint p75 (ms)", "INP rating (good, needs-improvement, poor)", "INP good share of visits (0-1)", "INP needs-improvement share (0-1)", "INP poor share (0-1)", "Cumulative Layout Shift p75", "CLS rating (good, needs-improvement, poor)", "CLS good share of visits (0-1)", "CLS needs-improvement share (0-1)", "CLS poor share (0-1)", "First Contentful Paint p75 (ms)", "Time to First Byte p75 (ms)", "Data window start", "Data window end", "Source route", "Source URL" ] }, "default": [ "scope", "formFactor", "passesCoreWebVitals", "lcpP75Ms", "lcpRating", "lcpGoodShare", "lcpNeedsImprovementShare", "lcpPoorShare", "inpP75Ms", "inpRating", "inpGoodShare", "inpNeedsImprovementShare", "inpPoorShare", "clsP75", "clsRating", "clsGoodShare", "clsNeedsImprovementShare", "clsPoorShare", "fcpP75Ms", "ttfbP75Ms", "collectionPeriodStart", "collectionPeriodEnd", "source", "sourceUrl" ] }, "formFactor": { "title": "Device", "enum": [ "ALL", "PHONE", "DESKTOP", "TABLET" ], "type": "string", "description": "Which device class the real-user data is split by. Google's mobile ranking signal uses phone data. A small site may have data for all devices combined but not for one device on its own.", "default": "ALL" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 3 } } }, "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 } } } } } } } } } }