For multiple-urls batch type, provide an array of urls to test. For other batch types, provide a single url in array and if multiple urls are provided, only first in the list will be used for the test. All invalid urls in the array will be ignored.
For multiple-devices batch type, provide an array of device ids to test or leave it empty for testing on all preset devices. For other batch types, provide a single device id in array and if multiple device ids are provided, only first in the list will be used for the test. All invalid device ids in the array will be ignored.
For multiple-locations batch type, provide an array of location ids to test or leave it empty for testing on all preset locations. For other batch types, provide just a single location id in array and if multiple location ids are provided, only first in the list will be used for the test. All invalid location ids in the array will be ignored.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SpeedVitals Docs","colors":{"primary":"#035FD7","light":"#E8EEFB","dark":"#16242E"},"logo":{"light":"https://mintcdn.com/speedvitals/N_w73itVpvAhFzMB/logo/light.svg?fit=max\u0026auto=format\u0026n=N_w73itVpvAhFzMB\u0026q=85\u0026s=1a50c557f46f085723d80f9341d106b7","dark":"https://mintcdn.com/speedvitals/N_w73itVpvAhFzMB/logo/dark.svg?fit=max\u0026auto=format\u0026n=N_w73itVpvAhFzMB\u0026q=85\u0026s=352dd015ced42999620b61834f2fa89a"},"favicon":"/favicon.png","navbar":{"links":[{"href":"https://speedvitals.com/contact-us","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://speedvitals.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.speedvitals.com/"},{"anchor":"Blog","icon":"newspaper","href":"https://speedvitals.com/blog/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"speedvitals","hasAudioNarration":false,"actualSubdomain":"speedvitals","customDomains":["developers.speedvitals.com"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-speedvitals-58e21a5a","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20d0835ba58cae093ec8d3","collectionId":"4a01e67f-b3b4-4d74-b4dd-a73a2be0ed0f","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20d0835ba58cae093ec8d3:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":15},{"language":"default","tag":"Lighthouse Tests","count":4},{"language":"default","tag":"Topics","count":3},{"language":"default","tag":"Devices","count":2},{"language":"default","tag":"Lighthouse Batch Tests","count":2},{"language":"default","tag":"Locations","count":2},{"language":"default","tag":"TTFB Regions","count":2},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Ping","count":1},{"language":"default","tag":"TTFB Tests","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test","slug":"/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test","pageMetadata":{"title":"Run a lighthouse batch test","description":"Runs a new lighthouse batch test.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /v1/lighthouse-batch-tests","href":"/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test","autogeneratedByOpenApi":true,"hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Runs a new lighthouse batch test.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a lighthouse batch test","description":"Runs a new lighthouse batch test.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /v1/lighthouse-batch-tests","href":"/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Lighthouse Batch Tests"],"summary":"Run a lighthouse batch test","description":"Runs a new lighthouse batch test.","operationId":"RunLighthouseBatchTest","requestBody":"a62cbeeb-bbf5-408d-8a0a-dee314cccd76","responses":{"201":"f038c35f-332a-4de2-951a-84fbc0a7de7c","400":"7d54bd96-930e-4185-a5d7-911ef6077e04","402":"fd0b1f1e-36bb-46a0-b718-e35dce88f9c9"},"method":"post","type":"path","servers":["696216de-a33b-484d-964e-277037d219d2"],"security":["22618c31-8264-4e20-8ce3-a82741956d58"],"path":"/v1/lighthouse-batch-tests","baseUrlOptions":["https://api.speedvitals.com"],"title":"Run a lighthouse batch test","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"This is the lighthouse batch test body object","content":{"application/json":{"schema":{"properties":{"urls":{"title":"list of urls","description":"For multiple-urls batch type, provide an array of urls to test. For other batch types, provide a single url in array and if multiple urls are provided, only first in the list will be used for the test. All invalid urls in the array will be ignored.","type":"array","items":{"maxLength":5000,"type":"string","uniqueKey":"urls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"urls","typeLabel":"string[]"},"devices":{"title":"list of devices","description":"For multiple-devices batch type, provide an array of device ids to test or leave it empty for testing on all preset devices. For other batch types, provide a single device id in array and if multiple device ids are provided, only first in the list will be used for the test. All invalid device ids in the array will be ignored.","type":"array","items":{"type":"string","example":"macbookAirM1","enum":["mobile","desktop","macbookAirM1","highEndLaptop","ipad102","galaxyTabS7","iphone13ProMax","iphone11","galaxyS10Plus","redmiNote8Pro","iphone7","galaxyA50","galaxyJ8","motoG5","redmi5A"],"maxLength":5000,"uniqueKey":"devices.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"devices","typeLabel":"enum\u003cstring>[]"},"locations":{"title":"list of locations","description":"For multiple-locations batch type, provide an array of location ids to test or leave it empty for testing on all preset locations. For other batch types, provide just a single location id in array and if multiple location ids are provided, only first in the list will be used for the test. All invalid location ids in the array will be ignored.","type":"array","items":{"type":"string","example":"us","enum":["us","ca","br","de","uk","nl","pl","ch","jp","in","sg","au","id","kr","tw"],"maxLength":5000,"uniqueKey":"locations.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"locations","typeLabel":"enum\u003cstring>[]"},"batch_type":{"description":"The type of batch test to run","type":"string","enum":["multiple-urls","multiple-devices","multiple-locations"],"uniqueKey":"batch_type","typeLabel":"enum\u003cstring>"},"config":{"type":"object","properties":{"connection":{"oneOf":[{"description":"Connection Type","type":"string","enum":["fiber","cable","dsl","5g","wifi_fast","wifi","4g_fast","4g","3g_fast","3g","3g_slow","2g_edge","2g",null],"maxLength":5000,"uniqueKey":"config.connection.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Connection Type","type":"null","enum":["fiber","cable","dsl","5g","wifi_fast","wifi","4g_fast","4g","3g_fast","3g","3g_slow","2g_edge","2g",null],"maxLength":5000,"uniqueKey":"config.connection.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.connection","typeLabel":"enum\u003cstring> | null"},"throttling_method":{"oneOf":[{"description":"Choose between simulated throttling and applied throttling","type":"string","maxLength":5000,"default":"simulated","uniqueKey":"config.throttling_method.oneOf.0","typeLabel":"string"},{"description":"Choose between simulated throttling and applied throttling","type":"null","maxLength":5000,"default":"simulated","uniqueKey":"config.throttling_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.throttling_method","typeLabel":"string | null"},"http_version":{"oneOf":[{"description":"Force HTTP/1.1 or HTTP/2(default)","type":"string","maxLength":5000,"default":"2","uniqueKey":"config.http_version.oneOf.0","typeLabel":"string"},{"description":"Force HTTP/1.1 or HTTP/2(default)","type":"null","maxLength":5000,"default":"2","uniqueKey":"config.http_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.http_version","typeLabel":"string | null"},"video":{"oneOf":[{"description":"Enable page load video","type":"boolean","maxLength":5000,"default":false,"uniqueKey":"config.video.oneOf.0","typeLabel":"boolean"},{"description":"Enable page load video","type":"null","maxLength":5000,"default":false,"uniqueKey":"config.video.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video","typeLabel":"boolean | null"},"adblock":{"oneOf":[{"description":"Enable Adblock","type":"boolean","default":false,"uniqueKey":"config.adblock.oneOf.0","typeLabel":"boolean"},{"description":"Enable Adblock","type":"null","default":false,"uniqueKey":"config.adblock.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.adblock","typeLabel":"boolean | null"},"user_agent":{"oneOf":[{"description":"Run test with custom user agent","type":"string","maxLength":5000,"uniqueKey":"config.user_agent.oneOf.0","typeLabel":"string"},{"description":"Run test with custom user agent","type":"null","maxLength":5000,"uniqueKey":"config.user_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.user_agent","typeLabel":"string | null"},"auth_username":{"oneOf":[{"description":"Username for authentication","type":"string","maxLength":5000,"uniqueKey":"config.auth_username.oneOf.0","typeLabel":"string"},{"description":"Username for authentication","type":"null","maxLength":5000,"uniqueKey":"config.auth_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.auth_username","typeLabel":"string | null"},"auth_password":{"oneOf":[{"description":"Password for authentication","type":"string","maxLength":5000,"uniqueKey":"config.auth_password.oneOf.0","typeLabel":"string"},{"description":"Password for authentication","type":"null","maxLength":5000,"uniqueKey":"config.auth_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.auth_password","typeLabel":"string | null"},"cookies":{"oneOf":[{"description":"List of session cookies","type":"array","items":{"type":"string","uniqueKey":"config.cookies.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxLength":5000,"uniqueKey":"config.cookies.oneOf.0","typeLabel":"string[]"},{"description":"List of session cookies","type":"null","items":{"type":"string"},"maxLength":5000,"uniqueKey":"config.cookies.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.cookies","typeLabel":"string[] | null"},"whitelist":{"oneOf":[{"description":"List of whitelisted urls(Max 5)","type":"array","items":{"type":"string","uniqueKey":"config.whitelist.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.whitelist.oneOf.0","typeLabel":"string[]"},{"description":"List of whitelisted urls(Max 5)","type":"null","items":{"type":"string"},"uniqueKey":"config.whitelist.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.whitelist","typeLabel":"string[] | null"},"blacklist":{"oneOf":[{"description":"List of blacklisted urls(Max 10)","type":"array","items":{"type":"string","uniqueKey":"config.blacklist.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.blacklist.oneOf.0","typeLabel":"string[]"},{"description":"List of blacklisted urls(Max 10)","type":"null","items":{"type":"string"},"uniqueKey":"config.blacklist.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.blacklist","typeLabel":"string[] | null"}},"uniqueKey":"config","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"urls":["https://speedvitals.com","https://blog.speedvitals.com"],"devices":["macbookAirM1"],"locations":["us"],"batch_type":"multiple-urls"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"f038c35f-332a-4de2-951a-84fbc0a7de7c":{"description":"A lighthouse batch report to be returned","content":{"application/json":{"schema":{"type":"object","required":["urls","devices","locations","batch_type"],"properties":{"urls":{"type":"array","items":{"type":"string","uniqueKey":"urls.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"urls","typeLabel":"string[]"},"devices":{"type":"array","items":{"type":"string","example":"macbookAirM1","enum":["mobile","desktop","macbookAirM1","highEndLaptop","ipad102","galaxyTabS7","iphone13ProMax","iphone11","galaxyS10Plus","redmiNote8Pro","iphone7","galaxyA50","galaxyJ8","motoG5","redmi5A"],"uniqueKey":"devices.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"devices","typeLabel":"enum\u003cstring>[]"},"locations":{"type":"array","items":{"type":"string","example":"us","enum":["us","ca","br","de","uk","nl","pl","ch","jp","in","sg","au","id","kr","tw"],"uniqueKey":"locations.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"locations","typeLabel":"enum\u003cstring>[]"},"batch_type":{"type":"string","enum":["multiple-urls","multiple-devices","multiple-locations"],"isRequired":true,"uniqueKey":"batch_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"config":{"type":"object","properties":{"connection":{"oneOf":[{"description":"Connection Type","type":"string","enum":["fiber","cable","dsl","5g","wifi_fast","wifi","4g_fast","4g","3g_fast","3g","3g_slow","2g_edge","2g",null],"maxLength":5000,"uniqueKey":"config.connection.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Connection Type","type":"null","enum":["fiber","cable","dsl","5g","wifi_fast","wifi","4g_fast","4g","3g_fast","3g","3g_slow","2g_edge","2g",null],"maxLength":5000,"uniqueKey":"config.connection.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.connection","typeLabel":"enum\u003cstring> | null"},"throttling_method":{"oneOf":[{"description":"Choose between simulated throttling and applied throttling","type":"string","maxLength":5000,"default":"simulated","uniqueKey":"config.throttling_method.oneOf.0","typeLabel":"string"},{"description":"Choose between simulated throttling and applied throttling","type":"null","maxLength":5000,"default":"simulated","uniqueKey":"config.throttling_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.throttling_method","typeLabel":"string | null"},"http_version":{"oneOf":[{"description":"Force HTTP/1.1 or HTTP/2(default)","type":"string","maxLength":5000,"default":"2","uniqueKey":"config.http_version.oneOf.0","typeLabel":"string"},{"description":"Force HTTP/1.1 or HTTP/2(default)","type":"null","maxLength":5000,"default":"2","uniqueKey":"config.http_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.http_version","typeLabel":"string | null"},"video":{"oneOf":[{"description":"Enable page load video","type":"boolean","maxLength":5000,"default":false,"uniqueKey":"config.video.oneOf.0","typeLabel":"boolean"},{"description":"Enable page load video","type":"null","maxLength":5000,"default":false,"uniqueKey":"config.video.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video","typeLabel":"boolean | null"},"adblock":{"oneOf":[{"description":"Enable Adblock","type":"boolean","default":false,"uniqueKey":"config.adblock.oneOf.0","typeLabel":"boolean"},{"description":"Enable Adblock","type":"null","default":false,"uniqueKey":"config.adblock.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.adblock","typeLabel":"boolean | null"},"user_agent":{"oneOf":[{"description":"Run test with custom user agent","type":"string","maxLength":5000,"uniqueKey":"config.user_agent.oneOf.0","typeLabel":"string"},{"description":"Run test with custom user agent","type":"null","maxLength":5000,"uniqueKey":"config.user_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.user_agent","typeLabel":"string | null"},"auth_username":{"oneOf":[{"description":"Username for authentication","type":"string","maxLength":5000,"uniqueKey":"config.auth_username.oneOf.0","typeLabel":"string"},{"description":"Username for authentication","type":"null","maxLength":5000,"uniqueKey":"config.auth_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.auth_username","typeLabel":"string | null"},"auth_password":{"oneOf":[{"description":"Password for authentication","type":"string","maxLength":5000,"uniqueKey":"config.auth_password.oneOf.0","typeLabel":"string"},{"description":"Password for authentication","type":"null","maxLength":5000,"uniqueKey":"config.auth_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.auth_password","typeLabel":"string | null"},"cookies":{"oneOf":[{"description":"List of session cookies","type":"array","items":{"type":"string","uniqueKey":"config.cookies.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxLength":5000,"uniqueKey":"config.cookies.oneOf.0","typeLabel":"string[]"},{"description":"List of session cookies","type":"null","items":{"type":"string"},"maxLength":5000,"uniqueKey":"config.cookies.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.cookies","typeLabel":"string[] | null"},"whitelist":{"oneOf":[{"description":"List of whitelisted urls(Max 5)","type":"array","items":{"type":"string","uniqueKey":"config.whitelist.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.whitelist.oneOf.0","typeLabel":"string[]"},{"description":"List of whitelisted urls(Max 5)","type":"null","items":{"type":"string"},"uniqueKey":"config.whitelist.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.whitelist","typeLabel":"string[] | null"},"blacklist":{"oneOf":[{"description":"List of blacklisted urls(Max 10)","type":"array","items":{"type":"string","uniqueKey":"config.blacklist.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.blacklist.oneOf.0","typeLabel":"string[]"},{"description":"List of blacklisted urls(Max 10)","type":"null","items":{"type":"string"},"uniqueKey":"config.blacklist.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.blacklist","typeLabel":"string[] | null"}},"uniqueKey":"config","typeLabel":"object"},"status":{"type":"string","enum":["idle","active","completed"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"lighthouse_version":{"description":"The version of the lighthouse used to run the tests","type":"string","uniqueKey":"lighthouse_version","typeLabel":"string"},"report_url":{"type":"string","uniqueKey":"report_url","typeLabel":"string"},"created_at":{"description":"Time at which the batch test was created. Measured in seconds since the Unix epoch.","type":"number","uniqueKey":"created_at","typeLabel":"number"},"expires_at":{"description":"Time at which the batch report will expire. Measured in seconds since the Unix epoch.","type":"number","uniqueKey":"expires_at","typeLabel":"number"},"reports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"reports.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","uniqueKey":"reports.items.[INDEX].url","typeLabel":"string"},"device":{"type":"string","example":"macbookAirM1","enum":["mobile","desktop","macbookAirM1","highEndLaptop","ipad102","galaxyTabS7","iphone13ProMax","iphone11","galaxyS10Plus","redmiNote8Pro","iphone7","galaxyA50","galaxyJ8","motoG5","redmi5A"],"uniqueKey":"reports.items.[INDEX].device","typeLabel":"enum\u003cstring>"},"location":{"type":"string","example":"us","enum":["us","ca","br","de","uk","nl","pl","ch","jp","in","sg","au","id","kr","tw"],"uniqueKey":"reports.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["idle","active","success","failed"],"uniqueKey":"reports.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"metrics":{"oneOf":[{"type":"object","properties":{"cumulative_layout_shift":{"description":"Cumulative Layout Shift","type":"number","example":0.01,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.cumulative_layout_shift","typeLabel":"number"},"first_contentful_paint":{"type":"number","description":"First Contentful Paint time (in milliseconds)","example":1232,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.first_contentful_paint","typeLabel":"number"},"first_meaningful_paint":{"description":"First Meaningful Paint time (in milliseconds)","type":"number","example":1245,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.first_meaningful_paint","typeLabel":"number"},"time_to_interactive":{"description":"Time to Interactive (in milliseconds)","type":"number","example":1458,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.time_to_interactive","typeLabel":"number"},"largest_contentful_paint":{"description":"Largest Contentful Paint time (in milliseconds)","type":"number","example":1245,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.largest_contentful_paint","typeLabel":"number"},"server_response_time":{"description":"TTFB (in milliseconds)","type":"number","example":70,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.server_response_time","typeLabel":"number"},"speed_index":{"description":"Speed Index (in milliseconds)","type":"number","example":1367,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.speed_index","typeLabel":"number"},"total_blocking_time":{"description":"Total Blocking time (in milliseconds)","type":"number","example":39,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.total_blocking_time","typeLabel":"number"},"performance_score":{"description":"Performance Score (in percentage)","type":"number","example":96,"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0.performance_score","typeLabel":"number"}},"uniqueKey":"reports.items.[INDEX].metrics.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"cumulative_layout_shift":{"description":"Cumulative Layout Shift","type":"number","example":0.01},"first_contentful_paint":{"type":"number","description":"First Contentful Paint time (in milliseconds)","example":1232},"first_meaningful_paint":{"description":"First Meaningful Paint time (in milliseconds)","type":"number","example":1245},"time_to_interactive":{"description":"Time to Interactive (in milliseconds)","type":"number","example":1458},"largest_contentful_paint":{"description":"Largest Contentful Paint time (in milliseconds)","type":"number","example":1245},"server_response_time":{"description":"TTFB (in milliseconds)","type":"number","example":70},"speed_index":{"description":"Speed Index (in milliseconds)","type":"number","example":1367},"total_blocking_time":{"description":"Total Blocking time (in milliseconds)","type":"number","example":39},"performance_score":{"description":"Performance Score (in percentage)","type":"number","example":96}},"uniqueKey":"reports.items.[INDEX].metrics.oneOf.1","typeLabel":"null"}],"uniqueKey":"reports.items.[INDEX].metrics","typeLabel":"object | null"},"report_url":{"oneOf":[{"description":"The URL at which SpeedVitals report is accessible (Present when status is success)","type":"string","uniqueKey":"reports.items.[INDEX].report_url.oneOf.0","typeLabel":"string"},{"description":"The URL at which SpeedVitals report is accessible (Present when status is success)","type":"null","uniqueKey":"reports.items.[INDEX].report_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"reports.items.[INDEX].report_url","typeLabel":"string | null"},"error":{"oneOf":[{"description":"Contains error code and description(present only if status is failed)","type":"object","properties":{"code":{"description":"Error code specific to lighthouse error","type":"string","uniqueKey":"reports.items.[INDEX].error.oneOf.0.code","typeLabel":"string"},"message":{"description":"Error message describing the summary of lighthouse error","type":"string","uniqueKey":"reports.items.[INDEX].error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"reports.items.[INDEX].error.oneOf.0","typeLabel":"object"},{"description":"Contains error code and description(present only if status is failed)","type":"null","properties":{"code":{"description":"Error code specific to lighthouse error","type":"string"},"message":{"description":"Error message describing the summary of lighthouse error","type":"string"}},"uniqueKey":"reports.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"reports.items.[INDEX].error","typeLabel":"object | null"}},"uniqueKey":"reports.items.[INDEX]","typeLabel":"object"},"uniqueKey":"reports","typeLabel":"object[]"}},"example":{"id":"lbt_IU8rN0XQmIWEqGkP","urls":["https://speedvitals.com","https://blog.speedvitals.com"],"devices":["macbookAirM1"],"locations":["us"],"batch_type":"multiple-urls","status":"active","lighthouse_version":"9.6.2","report_url":"https://speedvitals.com/result/afd98w0l/","created_at":1657539924734,"expires_at":1660131924733,"reports":[{"id":"lt_dObdG5EW4d231hto","url":"https://speedvitals.com","device":"macbookAirM1","location":"us","status":"success","metrics":{"cumulative_layout_shift":0,"first_contentful_paint":292,"first_meaningful_paint":297,"time_to_interactive":297,"largest_contentful_paint":434,"server_response_time":32,"speed_index":900,"total_blocking_time":0,"performance_score":100},"report_url":"https://speedvitals.com/report/speedvitals.com/IvWenx/","error":null},{"id":"lt_dmpbeQ2xk1XPh4UP","url":"https://blog.speedvitals.com","device":"macbookAirM1","location":"us","status":"idle","metrics":{"cumulative_layout_shift":0,"first_contentful_paint":322,"first_meaningful_paint":365,"time_to_interactive":368,"largest_contentful_paint":488,"server_response_time":68,"speed_index":1406,"total_blocking_time":0,"performance_score":99},"report_url":"https://speedvitals.com/report/blog.speedvitals.com/3t4lm7","error":null}]},"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"id":"lbt_IU8rN0XQmIWEqGkP","urls":["https://speedvitals.com","https://blog.speedvitals.com"],"devices":["macbookAirM1"],"locations":["us"],"batch_type":"multiple-urls","status":"idle","lighthouse_version":"9.6.2","report_url":"https://speedvitals.com/result/afd98w0l/","created_at":1657539924734,"expires_at":1660131924733,"reports":[{"id":"lt_dObdG5EW4d231hto","url":"https://speedvitals.com","device":"macbookAirM1","location":"us","status":"success","metrics":{"cumulative_layout_shift":0,"first_contentful_paint":292,"first_meaningful_paint":297,"time_to_interactive":297,"largest_contentful_paint":434,"server_response_time":32,"speed_index":900,"total_blocking_time":0,"performance_score":100},"report_url":"https://speedvitals.com/report/speedvitals.com/IvWenx/","error":null},{"id":"lt_dmpbeQ2xk1XPh4UP","url":"https://blog.speedvitals.com","device":"macbookAirM1","location":"us","status":"idle","metrics":{"cumulative_layout_shift":0,"first_contentful_paint":322,"first_meaningful_paint":365,"time_to_interactive":368,"largest_contentful_paint":488,"server_response_time":68,"speed_index":1406,"total_blocking_time":0,"performance_score":99},"report_url":"https://speedvitals.com/report/blog.speedvitals.com/3t4lm7","error":null}]}}},"exampleType":"examples"}},"exampleType":"examples"},"7d54bd96-930e-4185-a5d7-911ef6077e04":{"description":"Invalid Request body or missing required parameters","content":{"application/json":{"schema":{"description":"An error response from the SpeedVitals API","type":"object","properties":{"code":{"description":"An error code specific to the error.","type":"string","uniqueKey":"code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fd0b1f1e-36bb-46a0-b718-e35dce88f9c9":{"description":"Insufficient Credits","content":{"application/json":{"schema":{"description":"An error response from the SpeedVitals API","type":"object","properties":{"code":{"description":"An error code specific to the error.","type":"string","uniqueKey":"code","typeLabel":"string"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"22618c31-8264-4e20-8ce3-a82741956d58":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"696216de-a33b-484d-964e-277037d219d2":{"url":"https://api.speedvitals.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-KEY"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"speedvitals","siteName":"SpeedVitals Docs","title":"Run a lighthouse batch test - SpeedVitals Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-04T08:28:50.111Z","originalFileLocation":"api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Runs a new lighthouse batch test.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SpeedVitals Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a lighthouse batch test - SpeedVitals Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Runs a new lighthouse batch test.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SpeedVitals Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://speedvitals.mintlify.app/_mintlify/api/og/v2?division=Lighthouse+Batch+Tests\u0026amp;title=Run+a+lighthouse+batch+test\u0026amp;description=Runs+a+new+lighthouse+batch+test.\u0026amp;theme=0cf1f9cfa9ce132a2f451583\u0026amp;signature=6908dde1e1b9e9b3a9fe69569e8caf35cc7109d355d9a0132060e560802c6caf\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run a lighthouse batch test - SpeedVitals Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Runs a new lighthouse batch test.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://speedvitals.mintlify.app/_mintlify/api/og/v2?division=Lighthouse+Batch+Tests\u0026amp;title=Run+a+lighthouse+batch+test\u0026amp;description=Runs+a+new+lighthouse+batch+test.\u0026amp;theme=0cf1f9cfa9ce132a2f451583\u0026amp;signature=6908dde1e1b9e9b3a9fe69569e8caf35cc7109d355d9a0132060e560802c6caf\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/speedvitals/_y7c8wCDlt-D_A5l/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SpeedVitals Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#035FD7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.speedvitals.com/#organization\",\"name\":\"SpeedVitals Docs\",\"url\":\"https://developers.speedvitals.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/speedvitals/N_w73itVpvAhFzMB/logo/light.svg?fit=max\u0026auto=format\u0026n=N_w73itVpvAhFzMB\u0026q=85\u0026s=1a50c557f46f085723d80f9341d106b7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.speedvitals.com#website\",\"name\":\"SpeedVitals Docs\",\"url\":\"https://developers.speedvitals.com\",\"publisher\":{\"@id\":\"https://developers.speedvitals.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test#webpage\",\"url\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test\",\"name\":\"Run a lighthouse batch test\",\"description\":\"Runs a new lighthouse batch test.\",\"dateModified\":\"2026-02-04T08:28:50.111Z\",\"isPartOf\":{\"@id\":\"https://developers.speedvitals.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developers.speedvitals.com/api-reference/ping/check-api-status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a lighthouse batch test\",\"item\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test#apireference\",\"headline\":\"Run a lighthouse batch test\",\"name\":\"Run a lighthouse batch test\",\"description\":\"Runs a new lighthouse batch test.\",\"url\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test\",\"mainEntityOfPage\":{\"@id\":\"https://developers.speedvitals.com/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test#webpage\"},\"dateModified\":\"2026-02-04T08:28:50.111Z\",\"publisher\":{\"@id\":\"https://developers.speedvitals.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.speedvitals.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SpeedVitals Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SpeedVitals Docs","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.speedvitals.com/"},{"anchor":"Blog","icon":"newspaper","href":"https://speedvitals.com/blog/"}]},"groups":[{"group":"Topics","pages":[{"title":"Authentication","href":"/authentication"},{"title":"Rate Limits","href":"/rate-limits"},{"title":"Errors","href":"/errors"}]},{"group":"Endpoints","pages":[{"group":"Ping","pages":[{"title":"Check API status","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /ping","href":"/api-reference/ping/check-api-status"}]},{"group":"Devices","pages":[{"title":"List all devices","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/devices","href":"/api-reference/devices/list-all-devices"},{"title":"Get a device","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/devices/{id}","href":"/api-reference/devices/get-a-device"}]},{"group":"Locations","pages":[{"title":"List all locations","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/locations","href":"/api-reference/locations/list-all-locations"},{"title":"Get a location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/locations/{id}","href":"/api-reference/locations/get-a-location"}]},{"group":"TTFB Regions","pages":[{"title":"List all TTFB regions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/ttfb-regions","href":"/api-reference/ttfb-regions/list-all-ttfb-regions"},{"title":"Get a TTFB region","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/ttfb-regions/{id}","href":"/api-reference/ttfb-regions/get-a-ttfb-region"}]},{"group":"Lighthouse Tests","pages":[{"title":"List all lighthouse reports","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/lighthouse-tests","href":"/api-reference/lighthouse-tests/list-all-lighthouse-reports"},{"title":"Run a lighthouse test","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /v1/lighthouse-tests","href":"/api-reference/lighthouse-tests/run-a-lighthouse-test"},{"title":"Retrieve a lighthouse report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/lighthouse-tests/{id}","href":"/api-reference/lighthouse-tests/retrieve-a-lighthouse-report"},{"title":"Get a report resource","description":"Retrieves the resource of lighthouse report. Supply the unique test ID from either a lighthouse test creation request or the lighthouse tests list along with resource name to get that resource.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/lighthouse-tests/{id}/resources/{resource_name}","href":"/api-reference/lighthouse-tests/get-a-report-resource"}]},{"group":"Lighthouse Batch Tests","pages":[{"title":"Run a lighthouse batch test","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /v1/lighthouse-batch-tests","href":"/api-reference/lighthouse-batch-tests/run-a-lighthouse-batch-test"},{"title":"Retrieve a lighthouse batch report","description":"Retrieves the report of lighthouse test. Supply the unique test ID from either a lighthouse test creation request or the lighthouse tests list, and SpeedVitals will return the corresponding test information.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/lighthouse-batch-tests/{id}","href":"/api-reference/lighthouse-batch-tests/retrieve-a-lighthouse-batch-report"}]},{"group":"TTFB Tests","pages":[{"title":"Run a TTFB test","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /v1/ttfb-tests","href":"/api-reference/ttfb-tests/run-a-ttfb-test"}]},{"group":"Account","pages":[{"title":"Check credits","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /v1/account/credits","href":"/api-reference/account/check-credits"}]}]}]},"basePath":"","title":"Run a lighthouse batch test - SpeedVitals Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}