This API is currently in beta phase, so there may be changes to endpoints and data structure. We appreciate your understanding and patience as we work to improve the API.
The Wellows Public API allows you to programmatically access your SEO analytics and AI-powered insights. All API responses are returned in JSON format, making it easy to integrate with modern applications and tools.
Retrieve comprehensive site summaries with key SEO metrics and performance indicators. Access detailed overviews of your website’s health, indexing status, and optimization opportunities to make data-driven decisions.
Track your site’s performance over time with monitoring data. Identify trends, detect issues early, and measure the impact of your SEO efforts with historical data and real-time updates.
Each API key provides access to data belonging to its associated project or account, ensuring proper data isolation and security across your organization.
To begin using the API, you’ll need an API key from your user profile on our platform. This key authenticates your requests and grants access to your organization’s data.For authentication details, see:
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wellows Documentation","colors":{"primary":"#0554F2","light":"#C5DBFF","dark":"#00153E"},"logo":{"light":"https://app.wellows.com/media/app/logo-main.png","dark":"https://app.wellows.com/media/app/logo-white.png"},"favicon":"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=625ed5cacb8a7aa6e6786467f7146dcb","navbar":{"links":[{"href":"mailto:support@wellows.com","label":"Support"}]},"footer":{"socials":{"youtube":"https://www.youtube.com/@wellowsofficial","linkedin":"https://www.linkedin.com/company/wellowsofficial"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"website","href":"https://wellows.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wellows","hasAudioNarration":false,"actualSubdomain":"wellows","customDomains":["docs.wellows.com"],"gitSource":{"type":"github","owner":"wellows","repo":"wellows-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a6b4c36d13fba52b6735c2c","collectionId":"2e5805a6-3dc3-4f07-8451-68705affce1d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a6b4c36d13fba52b6735c2c"},"entitlements":{},"buildId":"6ae946b73da74a958a8e3e3b:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":" REST API","count":6},{"language":"default","tag":"Endpoint examples","count":4},{"language":"default","tag":"Overview","count":2}]},"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"An overview of the REST API and its capabilities","icon":"code","href":"/api-reference/introduction"},"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: \"An overview of the REST API and its capabilities\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`This API is currently in beta phase, so there may be changes to endpoints and data structure. We appreciate your understanding and patience as we work to improve the API.`})}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`The Wellows Public API allows you to programmatically access your SEO analytics and AI-powered insights. All API responses are returned in JSON format, making it easy to integrate with modern applications and tools.`}),`\n`,_jsx(Heading,{level:`3`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`All API requests should be made to:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://integrations.wellows.com/api/`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`key-capabilities`,children:`Key capabilities`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Validate your API key and check authentication status`}),`\n`,_jsx(_components.li,{children:`List and manage all projects associated with your account`}),`\n`,_jsx(_components.li,{children:`Retrieve comprehensive site summary overviews with key metrics`}),`\n`,_jsx(_components.li,{children:`Access site monitoring data to track performance over time`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-features`,children:`API Features`}),`\n`,_jsx(Heading,{level:`3`,id:`site-analytics`,children:`Site Analytics`}),`\n`,_jsx(_components.p,{children:`Retrieve comprehensive site summaries with key SEO metrics and performance indicators. Access detailed overviews of your website’s health, indexing status, and optimization opportunities to make data-driven decisions.`}),`\n`,_jsx(Heading,{level:`3`,id:`performance-monitoring`,children:`Performance Monitoring`}),`\n`,_jsx(_components.p,{children:`Track your site’s performance over time with monitoring data. Identify trends, detect issues early, and measure the impact of your SEO efforts with historical data and real-time updates.`}),`\n`,_jsx(Heading,{level:`3`,id:`project-scoped-data`,children:`Project-Scoped Data`}),`\n`,_jsx(_components.p,{children:`Each API key provides access to data belonging to its associated project or account, ensuring proper data isolation and security across your organization.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsx(_components.p,{children:`To begin using the API, you’ll need an API key from your user profile on our platform. This key authenticates your requests and grants access to your organization’s data.`}),`\n`,_jsx(_components.p,{children:`For authentication details, see:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/authentication`,children:_jsx(_components.strong,{children:`Authentication`})}),` - How to authenticate your requests`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-format`,children:`Response Format`}),`\n`,_jsx(_components.p,{children:`All responses follow a standard format:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Success message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"meta_data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Bad Request - Missing required parameters`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Unauthorized - Invalid or missing API key`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Forbidden - No access to the specified project`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Server error`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"An overview of the REST API and its capabilities","icon":"code","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[{"title":"Base URL","slug":"base-url","depth":3,"children":[]},{"title":"Key capabilities","slug":"key-capabilities","depth":3,"children":[]}]},{"title":"API Features","slug":"api-features","depth":2,"children":[{"title":"Site Analytics","slug":"site-analytics","depth":3,"children":[]},{"title":"Performance Monitoring","slug":"performance-monitoring","depth":3,"children":[]},{"title":"Project-Scoped Data","slug":"project-scoped-data","depth":3,"children":[]}]},{"title":"Getting Started","slug":"getting-started","depth":2,"children":[]},{"title":"Response Format","slug":"response-format","depth":2,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"wellows","siteName":"Wellows Documentation","title":"Introduction - Wellows Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-30T13:06:43.624Z","originalFileLocation":"api-reference/introduction.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=\"An overview of the REST API and its capabilities\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wellows Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Wellows Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"An overview of the REST API and its capabilities\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wellows Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wellows.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wellows.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Introduction\u0026amp;description=An+overview+of+the+REST+API+and+its+capabilities\u0026amp;theme=544c3041b135c0620c08ffa5\u0026amp;signature=855e90a4e6f870a42190c21932ac0c0ca21c7cf4e98ba5be0a915a7fa5a59594\">\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=\"Introduction - Wellows Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"An overview of the REST API and its capabilities\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wellows.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Introduction\u0026amp;description=An+overview+of+the+REST+API+and+its+capabilities\u0026amp;theme=544c3041b135c0620c08ffa5\u0026amp;signature=855e90a4e6f870a42190c21932ac0c0ca21c7cf4e98ba5be0a915a7fa5a59594\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/wellows/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wellows Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0554F2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wellows.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wellows.com/#organization\",\"name\":\"Wellows Documentation\",\"url\":\"https://docs.wellows.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://app.wellows.com/media/app/logo-main.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wellows.com#website\",\"name\":\"Wellows Documentation\",\"url\":\"https://docs.wellows.com\",\"publisher\":{\"@id\":\"https://docs.wellows.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wellows.com/api-reference/introduction#webpage\",\"url\":\"https://docs.wellows.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"An overview of the REST API and its capabilities\",\"dateModified\":\"2026-07-30T13:06:43.624Z\",\"isPartOf\":{\"@id\":\"https://docs.wellows.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wellows.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wellows.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Wellows Documentation\",\"item\":\"https://docs.wellows.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.wellows.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.wellows.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"An overview of the REST API and its capabilities\",\"url\":\"https://docs.wellows.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wellows.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-07-30T13:06:43.624Z\",\"publisher\":{\"@id\":\"https://docs.wellows.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wellows.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wellows Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wellows Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"website","href":"https://wellows.com/"}]},"tabs":[{"tab":" REST API","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"Introduction","icon":"code","href":"/api-reference/introduction"},{"title":"Authentication","description":"Learn how to authenticate API requests securely","icon":"lock","href":"/api-reference/authentication"}]},{"group":"Endpoint examples","pages":[{"title":"Validate API Key","openapi":"GET /validate","href":"/api-reference/endpoint/validate"},{"title":"List Projects","openapi":"GET /projects","href":"/api-reference/endpoint/projects"},{"title":"Get Overview","openapi":"GET /overview","href":"/api-reference/endpoint/overview"},{"title":"Get Monitoring","openapi":"GET /monitoring","href":"/api-reference/endpoint/monitoring"}]}]}]},"basePath":"","title":"Introduction - Wellows Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}
