Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.
API access is a planned feature for Growth and Enterprise plans. It isn’t available yet; full endpoint documentation will be published here when it ships.
The zued API lets you pull audit results, snapshot data, and metric history into your own dashboards, analytics workflows, or reporting tools, without logging into the app.
The API is on our roadmap for Growth and Enterprise plans and isn’t generally available yet. Full endpoint documentation will be published here once it ships.To register your interest, contact us at hey@zued.ai.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"zued","colors":{"primary":"#D4574F","light":"#D4574F","dark":"#E8716D"},"logo":{"light":"https://mintcdn.com/straiv-8893c9a9/1-QFXlBecaKYKPPH/logo/light.svg?fit=max\u0026auto=format\u0026n=1-QFXlBecaKYKPPH\u0026q=85\u0026s=ecae3482dbee29bef27ad84b7fb63405","dark":"https://mintcdn.com/straiv-8893c9a9/1-QFXlBecaKYKPPH/logo/dark.svg?fit=max\u0026auto=format\u0026n=1-QFXlBecaKYKPPH\u0026q=85\u0026s=86b5f1dbf172e8db5fa22189de6e4cd5"},"favicon":"https://mintcdn.com/straiv-8893c9a9/1-QFXlBecaKYKPPH/favicon.svg?fit=max\u0026auto=format\u0026n=1-QFXlBecaKYKPPH\u0026q=85\u0026s=42070fb3222be015076e67d170718a74","appearance":{"default":"dark","strict":false},"navbar":{"links":[{"href":"mailto:hey@zued.ai","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://app.zued.ai/signup"}},"footer":{"links":[{"header":"Resources","items":[{"label":"System Status","href":"https://status.zued.ai"},{"label":"Support","href":"mailto:hey@zued.ai"}]},{"header":"Legal","items":[{"label":"Imprint","href":"/imprint"},{"label":"Privacy","href":"/privacy"}]}]},"integrations":{"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"straiv-8893c9a9","hasAudioNarration":false,"actualSubdomain":"straiv-8893c9a9","customDomains":["docs.zued.ai"],"gitSource":{"type":"github","owner":"kevin-ki","repo":"zued","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4954ef49f5b7aedfdb803","collectionId":"63183b42-0614-4105-9384-0d568a0380f3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4954ef49f5b7aedfdb803"},"entitlements":{},"buildId":"6ae4954ef49f5b7aedfdb803","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"Visibility Metrics","count":7},{"language":"default","tag":"Understand Your Results","count":6},{"language":"default","tag":"Set Up Your Audit","count":5},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Take Action","count":3},{"language":"default","tag":"API","count":2},{"language":"default","tag":"FAQ","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}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"#built-with-mintlify .flex:has(>button[aria-label]),#built-with-mintlify [data-testid=theme-toggle],#built-with-mintlify button[aria-label*=theme]{display:none}"}],"page":{"pagePath":"api-reference","slug":"/api-reference","pageMetadata":{"title":"API Reference","description":"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.","href":"/api-reference"},"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: \"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\"\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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Info}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`API access is a planned feature for `,_jsx(_components.strong,{children:`Growth`}),` and `,_jsx(_components.strong,{children:`Enterprise`}),` plans. It isn’t available yet; full endpoint documentation will be published here when it ships.`]})}),`\n`,_jsx(_components.p,{children:`The zued API lets you pull audit results, snapshot data, and metric history into your own dashboards, analytics workflows, or reporting tools, without logging into the app.`}),`\n`,_jsx(Heading,{level:`2`,id:`what-you-can-access`,children:`What You Can Access`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Alignment scores and breakdowns per URL and prompt`}),`\n`,_jsx(_components.li,{children:`Technical scores per URL`}),`\n`,_jsx(_components.li,{children:`Snapshot history and week-over-week deltas`}),`\n`,_jsx(_components.li,{children:`Recommendations and Quick Wins lists`}),`\n`,_jsx(_components.li,{children:`Visibility metrics (Share of Voice, Citation Share, Selection Rate)`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`availability`,children:`Availability`}),`\n`,_jsxs(_components.p,{children:[`The API is on our roadmap for `,_jsx(_components.strong,{children:`Growth`}),` and `,_jsx(_components.strong,{children:`Enterprise`}),` plans and isn’t generally available yet. Full endpoint documentation will be published here once it ships.`]}),`\n`,_jsxs(_components.p,{children:[`To register your interest, contact us at `,_jsx(_components.a,{href:`mailto:hey@zued.ai`,children:`hey@zued.ai`}),`.`]})]})}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":"API Reference","description":"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.","href":"/api-reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What You Can Access","slug":"what-you-can-access","depth":2,"children":[]},{"title":"Availability","slug":"availability","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"straiv-8893c9a9","siteName":"zued","title":"API Reference - zued","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T16:04:38.547Z","originalFileLocation":"api-reference.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=\"dark\"}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=\"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\">\u003cmeta data-mint-head name=\"application-name\" content=\"zued\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_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/straiv-8893c9a9/veOHTz-WTWY84vYX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - zued\">\u003cmeta data-mint-head property=\"og:description\" content=\"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"zued\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zued.ai/api-reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://straiv-8893c9a9.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=API+Reference\u0026amp;description=Programmatic+access+to+your+zued+audit+data.+Coming+soon+on+Growth+and+Enterprise+plans.\u0026amp;theme=e5458bfc09765201833b9248\u0026amp;signature=7fba475277480a7ff762acd3504bdcc11dcd79f4f95437720f18f1b509a2e042\">\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=\"API Reference - zued\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://straiv-8893c9a9.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=API+Reference\u0026amp;description=Programmatic+access+to+your+zued+audit+data.+Coming+soon+on+Growth+and+Enterprise+plans.\u0026amp;theme=e5458bfc09765201833b9248\u0026amp;signature=7fba475277480a7ff762acd3504bdcc11dcd79f4f95437720f18f1b509a2e042\">\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/straiv-8893c9a9/veOHTz-WTWY84vYX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"zued\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D4574F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zued.ai/api-reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zued.ai/#organization\",\"name\":\"zued\",\"url\":\"https://docs.zued.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/straiv-8893c9a9/1-QFXlBecaKYKPPH/logo/light.svg?fit=max\u0026auto=format\u0026n=1-QFXlBecaKYKPPH\u0026q=85\u0026s=ecae3482dbee29bef27ad84b7fb63405\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zued.ai#website\",\"name\":\"zued\",\"url\":\"https://docs.zued.ai\",\"publisher\":{\"@id\":\"https://docs.zued.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zued.ai/api-reference#webpage\",\"url\":\"https://docs.zued.ai/api-reference\",\"name\":\"API Reference\",\"description\":\"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\",\"dateModified\":\"2026-10-09T16:04:38.547Z\",\"isPartOf\":{\"@id\":\"https://docs.zued.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zued.ai/api-reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zued.ai/api-reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"zued\",\"item\":\"https://docs.zued.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.zued.ai/api-reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.zued.ai/api-reference#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"Programmatic access to your zued audit data. Coming soon on Growth and Enterprise plans.\",\"url\":\"https://docs.zued.ai/api-reference\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zued.ai/api-reference#webpage\"},\"dateModified\":\"2026-10-09T16:04:38.547Z\",\"publisher\":{\"@id\":\"https://docs.zued.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zued.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"zued\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"zued","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/faq"}]},{"tab":"API","groups":[{"group":"API","pages":[{"title":"API Reference","href":"/api-reference"}]}]}]},"basePath":"","title":"API Reference - zued","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}
