The SpeedVitals REST API. Please see https://docs.speedvitals.com/api/ for more details. This is version 0.1.0 of this API documentation. Last update on Oct 27, 2023.
{"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.3902","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},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","description":"Welcome to API Reference of SpeedVitals","href":"/index","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: \"Welcome to API Reference of SpeedVitals\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`The SpeedVitals REST API. Please see `,_jsx(_components.a,{href:`https://docs.speedvitals.com/api/`,children:`https://docs.speedvitals.com/api/`}),` for more details. This is version 0.1.0 of this API documentation. Last update on Oct 27, 2023.`]})}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":"Introduction","description":"Welcome to API Reference of SpeedVitals","href":"/index","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"speedvitals","siteName":"SpeedVitals Docs","title":"Introduction - SpeedVitals Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-04T09:21:27.969Z","originalFileLocation":"index.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=\"Welcome to API Reference of SpeedVitals\">\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=\"Introduction - SpeedVitals Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to API Reference of SpeedVitals\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SpeedVitals Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.speedvitals.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - SpeedVitals Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to API Reference of SpeedVitals\">\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\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\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","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","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"}]}]}]},"title":"Introduction - SpeedVitals Docs","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":[],"chunks":[]}
