The brand’s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run’s score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.
The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity
with it); the loser-side floor stays a diagnostic and isn't surfaced here.
The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity
with it); the loser-side floor stays a diagnostic and isn't surfaced here.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scrunch API Docs","colors":{"primary":"#84A027","light":"#D8FC3B","dark":"#434E0D"},"logo":{"light":"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-dark.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=1ea209cf21e43eae27a79f766cb2cd31","dark":"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-light.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=f34563ac089933acd9bc841be78f0869","href":"https://developers.scrunch.com/"},"favicon":"https://mintcdn.com/scrunchai/lCDS3kviKweSb6eg/logo/favicon-green.png?fit=max\u0026auto=format\u0026n=lCDS3kviKweSb6eg\u0026q=85\u0026s=87f0c724d3b7bb2f310e2ffd6b54a30e","api":{"examples":{"prefill":true}},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"https://helpcenter.scrunchai.com/en/","label":"Help Center"},{"href":"https://scrunch.com/blog","label":"Blog"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.scrunchai.com"}},"footer":{"socials":{"x":"https://x.com/scrunchai","linkedin":"https://linkedin.com/company/scrunchai"}},"integrations":{"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","mcp","claude","chatgpt"],"display":"header"},"thumbnails":{"fonts":{"family":"Inter"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"flag","href":"https://status.scrunchai.com"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scrunchai","hasAudioNarration":false,"actualSubdomain":"scrunchai","customDomains":["developers.scrunch.com"],"gitSource":{"type":"github","owner":"excelsa-labs","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4c772fe0f1c90cb90f096","collectionId":"d1631b18-125b-49d3-9a0e-0bcec78c57ca","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4c772fe0f1c90cb90f096"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4c772fe0f1c90cb90f096","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"MCP","count":40},{"language":"default","tag":"Workflows","count":24},{"language":"default","tag":"Configure","count":22},{"language":"default","tag":"Measure","count":21},{"language":"default","tag":"Configuration API","count":19},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Deprecated","count":14},{"language":"default","tag":"Prompt Library","count":12},{"language":"default","tag":"Optimize","count":11}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@scrunchai.com","showHelpButton":false}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"styles/global.css","content":"html.dark .welcome-card-img-dark{display:block!important}.welcome-card-img-dark,html.dark .welcome-card-img-light{display:none!important}.welcome-card{display:block;color:inherit}.welcome-card,.welcome-card p{text-decoration:none!important;border-bottom:none!important}.welcome-card-img{width:100%;border-radius:12px;display:block;transition:transform .2s ease;pointer-events:none}.welcome-card:hover .welcome-card-img{transform:scale(1.03)}.api-intro-hero{display:grid;grid-template-columns:3fr 2fr;gap:32px;align-items:center;margin-bottom:8px}.api-intro-hero-img{width:100%;max-width:280px;justify-self:end;border-radius:12px}@media (max-width:640px){.api-intro-hero{grid-template-columns:1fr}.api-intro-hero-img{display:none}}html:not(.dark) .prompt{background-color:#fff!important}html:not(.dark) .mintlify,html:not(.dark) .pageWrapper,html:not(.dark) body,html:not(.dark) body>div,html:not(.dark) main{background-color:#fbf9f6!important}.update h2{font-size:1.0625rem;line-height:1.45;font-weight:600;letter-spacing:-.01em;margin-top:0;margin-bottom:.375rem}.update [data-as=p]+[data-as=p],.update h2~h2{display:block;margin-top:1.375rem;padding-top:1.375rem;border-top:1px solid rgb(0 0 0/.07)}html.dark .cl-jump,html.dark .update [data-as=p]+[data-as=p],html.dark .update h2~h2{border-top-color:rgb(255 255 255/.1)}.update{scroll-margin-top:7rem}.cl-jump{display:flex;flex-direction:column;padding-top:1.25rem;border-top:1px solid rgb(0 0 0/.07)}.cl-jump-title{font-weight:500;color:rgb(55 65 81);margin-bottom:.75rem}html.dark .cl-jump-title{color:rgb(209 213 219)}.cl-jump-year{font-size:.6875rem;font-weight:600;letter-spacing:.06em;text-transform:uppercase;color:rgb(107 114 128);margin-bottom:.5rem}.cl-jump-months{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:.25rem;list-style:none;margin:0 0 .75rem;padding:0}.cl-jump-months:last-child{margin-bottom:0}.cl-jump-month{display:flex;align-items:baseline;justify-content:space-between;gap:.5rem;width:100%;padding:.25rem .5rem;border-radius:.375rem;font-size:.8125rem;line-height:1.4;color:rgb(75 85 99);background:0 0;cursor:pointer;transition:background-color .12s ease,color .12s ease}html.dark .cl-jump-month{color:rgb(156 163 175)}.cl-jump-month:hover{background:rgb(0 0 0/.04);color:rgb(17 24 39)}html.dark .cl-jump-month:hover{background:rgb(255 255 255/.06);color:rgb(243 244 246)}.cl-jump-month.is-active{background:rgb(174 206 49/.45);color:#40362e;font-weight:500}html.dark .cl-jump-month.is-active{background:rgb(132 160 39/.4);color:#fff}.cl-jump-count{font-variant-numeric:tabular-nums;font-size:.75rem;opacity:.55}.cl-cat--analytics{--cl-bg:rgb(60 103 245 / 0.18);--cl-fg:#1F2CAE}.cl-cat--integrations{--cl-bg:rgb(31 44 174 / 0.16);--cl-fg:#1F2CAE}.cl-cat--platform{--cl-bg:rgb(147 192 254 / 0.45);--cl-fg:#1F2CAE}.cl-cat--settings-admin{--cl-bg:rgb(184 171 142 / 0.45);--cl-fg:#40362E}.cl-cat--ui-ux{--cl-bg:rgb(239 190 3 / 0.35);--cl-fg:#88520B}.cl-cat--data-crawling{--cl-bg:rgb(255 232 67 / 0.55);--cl-fg:#88520B}.cl-cat--performance{--cl-bg:rgb(136 82 11 / 0.16);--cl-fg:#88520B}.cl-cat--api-mcp{--cl-bg:rgb(88 107 22 / 0.13);--cl-fg:#586B16}.cl-cat--bug-fix{--cl-bg:#F1E8C7;--cl-fg:#40362E}.cl-cat--general{--cl-bg:transparent;--cl-fg:#40362E;box-shadow:inset 0 0 0 1px rgb(64 54 46/.35)}html.dark .cl-cat--analytics{--cl-bg:rgb(60 103 245 / 0.30);--cl-fg:#93C0FE}html.dark .cl-cat--integrations{--cl-bg:rgb(31 44 174 / 0.50);--cl-fg:#93C0FE}html.dark .cl-cat--platform{--cl-bg:rgb(147 192 254 / 0.20);--cl-fg:#93C0FE}html.dark .cl-cat--settings-admin{--cl-bg:rgb(184 171 142 / 0.22);--cl-fg:#B8AB8E}html.dark .cl-cat--ui-ux{--cl-bg:rgb(239 190 3 / 0.24);--cl-fg:#FFE843}html.dark .cl-cat--data-crawling{--cl-bg:rgb(255 232 67 / 0.16);--cl-fg:#FFE843}html.dark .cl-cat--api-mcp{--cl-bg:rgb(88 107 22 / 0.45);--cl-fg:#AECE31}html.dark .cl-cat--performance{--cl-bg:rgb(136 82 11 / 0.45);--cl-fg:#FFE843}html.dark .cl-cat--bug-fix{--cl-bg:rgb(241 232 199 / 0.20);--cl-fg:#F1E8C7}html.dark .cl-cat--general{--cl-bg:transparent;--cl-fg:#B8AB8E;box-shadow:inset 0 0 0 1px rgb(184 171 142/.35)}#changelog-filters-content button.cl-cat,[data-component-part=update-tag].cl-cat{font-weight:500;background-color:var(--cl-bg)!important;color:var(--cl-fg)!important}[data-component-part=update-tag].cl-cat{padding:.125rem .5rem}#changelog-filters-content button{transition:box-shadow .15s ease,transform .15s ease}#changelog-filters-content button:hover{box-shadow:0 2px 6px rgb(64 54 46/.16),0 1px 2px rgb(64 54 46/.1);transform:translateY(-1px)}html.dark #changelog-filters-content button:hover{box-shadow:0 2px 6px rgb(0 0 0/.5),0 1px 2px rgb(0 0 0/.35)}@media (prefers-reduced-motion:reduce){#changelog-filters-content button{transition:none}#changelog-filters-content button:hover{transform:none}}#changelog-filters-content button,.cl-jump-month,.update [data-component-part=update-label],.update [data-component-part=update-tag]{border-radius:9999px}"}],"page":{"pagePath":"api-reference/audit-scores/get-site-audit-score","slug":"/api-reference/audit-scores/get-site-audit-score","pageMetadata":{"title":"Get Site Audit Score","description":"The brand's site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (`generated_at`), the previous run's score for a delta, and `headroom` (the projected site score per metric if every surfaced opportunity is fixed). `null` when the brand has no audit yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/site","href":"/api-reference/audit-scores/get-site-audit-score","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"The brand’s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (\", _jsx(_components.code, {\n children: \"generated_at\"\n }), \"), the previous run’s score for a delta, and \", _jsx(_components.code, {\n children: \"headroom\"\n }), \" (the projected site score per metric if every surfaced opportunity is fixed). \", _jsx(_components.code, {\n children: \"null\"\n }), \" when the brand has no audit yet.\"]\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":"Get Site Audit Score","description":"The brand's site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (`generated_at`), the previous run's score for a delta, and `headroom` (the projected site score per metric if every surfaced opportunity is fixed). `null` when the brand has no audit yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/site","href":"/api-reference/audit-scores/get-site-audit-score","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/scrunchai/bca9f10e73242105/changelog-enhance.js"],"openApiReferenceData":{"operation":{"tags":["audit-scores"],"summary":"Get Site Audit Score","description":"The brand's site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (`generated_at`), the previous run's score for a delta, and `headroom` (the projected site score per metric if every surfaced opportunity is fixed). `null` when the brand has no audit yet.","operationId":"getSiteAuditScore","security":["2eca4758-cd9d-475f-a789-5ce75fe87c28"],"parameters":["9c61c8cf-f03b-4f2c-b3a7-15078345acf3"],"responses":{"200":"bc2e6065-93e0-48af-a1f3-9e65372eb9c4","422":"57fb27c5-02e9-4a1a-a603-1ad19fe117ed"},"method":"get","type":"path","servers":["a7ebcd54-f176-463c-a82d-bef063057c30"],"path":"/{brand_id}/audit-scores/site","baseUrlOptions":["https://api.scrunchai.com/v1"],"title":"Get Site Audit Score","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"9c61c8cf-f03b-4f2c-b3a7-15078345acf3":{"name":"brand_id","in":"path","required":true,"schema":{"type":"integer","title":"Brand Id","isRequired":true,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"bc2e6065-93e0-48af-a1f3-9e65372eb9c4":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"SiteScoreModel","description":"A brand's latest site-level score, from its most recent bulk audit run.","required":["brand_id","model_version","generated_at","n_pages","total_prompts","score"],"properties":{"brand_id":{"type":"integer","title":"Brand Id","isRequired":true,"uniqueKey":"oneOf.0.brand_id","typeLabel":"integer"},"model_version":{"type":"string","title":"Model Version","isRequired":true,"uniqueKey":"oneOf.0.model_version","typeLabel":"string"},"generated_at":{"type":"string","format":"date-time","title":"Generated At","isRequired":true,"uniqueKey":"oneOf.0.generated_at","typeLabel":"string\u003cdate-time>"},"n_pages":{"type":"integer","title":"N Pages","isRequired":true,"uniqueKey":"oneOf.0.n_pages","typeLabel":"integer"},"total_prompts":{"type":"integer","title":"Total Prompts","isRequired":true,"uniqueKey":"oneOf.0.total_prompts","typeLabel":"integer"},"score":{"properties":{"retrievability":{"type":"number","title":"Retrievability","isRequired":true,"uniqueKey":"oneOf.0.score.retrievability","typeLabel":"number"},"citability":{"type":"number","title":"Citability","isRequired":true,"uniqueKey":"oneOf.0.score.citability","typeLabel":"number"}},"type":"object","required":["retrievability","citability"],"title":"DisplayedScore","description":"The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity\nwith it); the loser-side floor stays a diagnostic and isn't surfaced here.","isRequired":true,"uniqueKey":"oneOf.0.score","typeLabel":"DisplayedScore · object"},"previous":{"oneOf":[{"type":"object","title":"DisplayedScore","description":"The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity\nwith it); the loser-side floor stays a diagnostic and isn't surfaced here.","required":["retrievability","citability"],"properties":{"retrievability":{"type":"number","title":"Retrievability","isRequired":true,"uniqueKey":"oneOf.0.previous.oneOf.0.retrievability","typeLabel":"number"},"citability":{"type":"number","title":"Citability","isRequired":true,"uniqueKey":"oneOf.0.previous.oneOf.0.citability","typeLabel":"number"}},"uniqueKey":"oneOf.0.previous.oneOf.0","typeLabel":"DisplayedScore · object"},{"type":"null","uniqueKey":"oneOf.0.previous.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.previous","typeLabel":"DisplayedScore · object | null"},"previous_absent_reason":{"oneOf":[{"type":"string","title":"Previous Absent Reason","enum":["no_prior_run","not_comparable"],"uniqueKey":"oneOf.0.previous_absent_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Previous Absent Reason","uniqueKey":"oneOf.0.previous_absent_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.previous_absent_reason","typeLabel":"enum\u003cstring> | null"},"previous_absent_detail":{"oneOf":[{"type":"string","title":"Previous Absent Detail","uniqueKey":"oneOf.0.previous_absent_detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Previous Absent Detail","uniqueKey":"oneOf.0.previous_absent_detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.previous_absent_detail","typeLabel":"string | null"},"worst_page_url":{"oneOf":[{"type":"string","title":"Worst Page Url","uniqueKey":"oneOf.0.worst_page_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Worst Page Url","uniqueKey":"oneOf.0.worst_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.worst_page_url","typeLabel":"string | null"},"best_page_url":{"oneOf":[{"type":"string","title":"Best Page Url","uniqueKey":"oneOf.0.best_page_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Best Page Url","uniqueKey":"oneOf.0.best_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.best_page_url","typeLabel":"string | null"},"headroom":{"oneOf":[{"type":"object","title":"SiteHeadroomModel","required":["retrievability","citeability"],"properties":{"retrievability":{"properties":{"current":{"type":"number","title":"Current","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability.current","typeLabel":"number"},"projected":{"type":"number","title":"Projected","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability.projected","typeLabel":"number"},"lift":{"type":"number","title":"Lift","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability.lift","typeLabel":"number"},"signals":{"type":"integer","title":"Signals","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability.signals","typeLabel":"integer"},"listable_signals":{"type":"integer","title":"Listable Signals","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability.listable_signals","typeLabel":"integer"}},"type":"object","required":["current","projected","lift","signals","listable_signals"],"title":"HeadroomMetricModel","description":"One metric's projected site score if every surfaced opportunity on the audited pages is fixed.\nAll 0-100. `projected` is the prompt-weighted average of each page's fixed score (gains add up\nwithin a page, capped at 100), not a sum across pages — so it stays a faithful score, not 100.","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.retrievability","typeLabel":"HeadroomMetricModel · object"},"citeability":{"properties":{"current":{"type":"number","title":"Current","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability.current","typeLabel":"number"},"projected":{"type":"number","title":"Projected","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability.projected","typeLabel":"number"},"lift":{"type":"number","title":"Lift","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability.lift","typeLabel":"number"},"signals":{"type":"integer","title":"Signals","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability.signals","typeLabel":"integer"},"listable_signals":{"type":"integer","title":"Listable Signals","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability.listable_signals","typeLabel":"integer"}},"type":"object","required":["current","projected","lift","signals","listable_signals"],"title":"HeadroomMetricModel","description":"One metric's projected site score if every surfaced opportunity on the audited pages is fixed.\nAll 0-100. `projected` is the prompt-weighted average of each page's fixed score (gains add up\nwithin a page, capped at 100), not a sum across pages — so it stays a faithful score, not 100.","isRequired":true,"uniqueKey":"oneOf.0.headroom.oneOf.0.citeability","typeLabel":"HeadroomMetricModel · object"}},"uniqueKey":"oneOf.0.headroom.oneOf.0","typeLabel":"SiteHeadroomModel · object"},{"type":"null","uniqueKey":"oneOf.0.headroom.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.headroom","typeLabel":"SiteHeadroomModel · object | null"},"selection_changed_since_audit":{"type":"boolean","title":"Selection Changed Since Audit","default":false,"uniqueKey":"oneOf.0.selection_changed_since_audit","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"SiteScoreModel · object"},{"type":"null","title":"Response Getsiteauditscore","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"SiteScoreModel · object | null"},"examples":{"Example":{"title":"Example","value":{"brand_id":123,"model_version":"\u003cstring>","generated_at":"2023-11-07T05:31:56Z","n_pages":123,"total_prompts":123,"score":{"retrievability":123,"citability":123},"previous":{"retrievability":123,"citability":123},"previous_absent_reason":"no_prior_run","previous_absent_detail":"\u003cstring>","worst_page_url":"\u003cstring>","best_page_url":"\u003cstring>","headroom":{"retrievability":{"current":123,"projected":123,"lift":123,"signals":123,"listable_signals":123},"citeability":{"current":123,"projected":123,"lift":123,"signals":123,"listable_signals":123}},"selection_changed_since_audit":false}}},"exampleType":"generated"}},"exampleType":"generated"},"57fb27c5-02e9-4a1a-a603-1ad19fe117ed":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2eca4758-cd9d-475f-a789-5ce75fe87c28":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":["query"],"schemeName":"HTTPBearer"}}},"servers":{"a7ebcd54-f176-463c-a82d-bef063057c30":{"url":"https://api.scrunchai.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":["query"],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"scrunchai","siteName":"Scrunch API Docs","title":"Get Site Audit Score - Scrunch API Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T16:36:08.233Z","originalFileLocation":"api-reference/audit-scores/get-site-audit-score.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=\"The brand\u0026#x27;s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run\u0026#x27;s score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scrunch API 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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Site Audit Score - Scrunch API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The brand\u0026#x27;s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run\u0026#x27;s score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scrunch API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scrunchai.mintlify.app/_mintlify/api/og/v2?division=Audit+Scores+API\u0026amp;title=Get+Site+Audit+Score\u0026amp;description=The+brand%27s+site-level+AI-visibility+score+%E2%80%94+retrievability+and+citability+rolled+up+across+the+whole+site+%28the+same+numbers+the+Site+Optimization+header+shows%29\u0026amp;theme=93ec30fdb3256642634f8dc2\u0026amp;signature=be3177d55613b69eb378c32eeacc641b315a1712fcdd7bc9b1898f79346608c5\">\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=\"Get Site Audit Score - Scrunch API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The brand\u0026#x27;s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run\u0026#x27;s score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scrunchai.mintlify.app/_mintlify/api/og/v2?division=Audit+Scores+API\u0026amp;title=Get+Site+Audit+Score\u0026amp;description=The+brand%27s+site-level+AI-visibility+score+%E2%80%94+retrievability+and+citability+rolled+up+across+the+whole+site+%28the+same+numbers+the+Site+Optimization+header+shows%29\u0026amp;theme=93ec30fdb3256642634f8dc2\u0026amp;signature=be3177d55613b69eb378c32eeacc641b315a1712fcdd7bc9b1898f79346608c5\">\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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scrunch API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#84A027\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/audit-scores/get-site-audit-score.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.scrunch.com/#organization\",\"name\":\"Scrunch API Docs\",\"url\":\"https://developers.scrunch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-dark.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=1ea209cf21e43eae27a79f766cb2cd31\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.scrunch.com#website\",\"name\":\"Scrunch API Docs\",\"url\":\"https://developers.scrunch.com\",\"publisher\":{\"@id\":\"https://developers.scrunch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score#webpage\",\"url\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score\",\"name\":\"Get Site Audit Score\",\"description\":\"The brand's site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run's score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.\",\"dateModified\":\"2026-10-30T16:36:08.233Z\",\"isPartOf\":{\"@id\":\"https://developers.scrunch.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Optimize\",\"item\":\"https://developers.scrunch.com/api-reference/site-optimization/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Audit Scores API\",\"item\":\"https://developers.scrunch.com/api-reference/audit-scores/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Site Audit Score\",\"item\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score#apireference\",\"headline\":\"Get Site Audit Score\",\"name\":\"Get Site Audit Score\",\"description\":\"The brand's site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run's score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.\",\"url\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score\",\"mainEntityOfPage\":{\"@id\":\"https://developers.scrunch.com/api-reference/audit-scores/get-site-audit-score#webpage\"},\"dateModified\":\"2026-10-30T16:36:08.233Z\",\"publisher\":{\"@id\":\"https://developers.scrunch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.scrunch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Scrunch API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Scrunch API Docs","nav":{"global":{"anchors":[{"anchor":"Status","icon":"flag","href":"https://status.scrunchai.com"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"title":"Scrunch REST API Directory and Authentication","sidebarTitle":"Introduction","icon":"light-switch-off","href":"/api-reference/introduction"},{"group":"Measure","icon":"chart-mixed","pages":[{"group":"Query API","public":true,"pages":[{"title":"Query API: Aggregated AI Visibility Metrics","sidebarTitle":"Overview","href":"/api-reference/query/overview"},{"title":"Query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/query","href":"/api-reference/query"},{"title":"Structured Query API: Multi-Metric JSON Endpoint","sidebarTitle":"Structured Query","href":"/api-reference/query/structured-query"}]},{"group":"Responses API","public":true,"pages":[{"title":"Responses API: Raw AI Answers and Citations","sidebarTitle":"Overview","href":"/api-reference/responses/overview"},{"title":"List Responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/responses","href":"/api-reference/list-responses"}]},{"group":"Signals API","public":true,"pages":[{"title":"Signals API: Detected changes in AI visibility","sidebarTitle":"Overview","href":"/api-reference/signals/overview"},{"title":"List Signals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals","href":"/api-reference/signals/list-signals"},{"title":"Get Signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/{signal_id}","href":"/api-reference/signals/get-signal"},{"title":"List Signal Anchor Dates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/anchors","href":"/api-reference/signals/list-signal-anchor-dates"},{"title":"List Signal Reactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/reactions","href":"/api-reference/signals/list-signal-reactions"},{"title":"Set Signal Reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /{brand_id}/signals/{signal_id}/reaction","href":"/api-reference/signals/set-signal-reaction"},{"title":"Clear Signal Reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/signals/{signal_id}/reaction","href":"/api-reference/signals/clear-signal-reaction"}]},{"group":"Agent Traffic API","public":true,"pages":[{"title":"Agent Traffic API: Monitor AI Bot Crawls","sidebarTitle":"Overview","href":"/api-reference/agent-traffic/overview"},{"title":"Get Agent Traffic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sites/{site_id}/agent-traffic","href":"/api-reference/agent-traffic/get-agent-traffic"},{"title":"Send Custom Agent Traffic Events","api":"POST https://webhooks.scrunchai.com/v1/sites/{site_id}/platforms/custom/web-traffic","href":"/api-reference/agent-traffic/post-custom-web-traffic"}]},{"group":"AI Referrals API","public":true,"pages":[{"title":"AI Referrals API: Push AI-Sourced Traffic Data","sidebarTitle":"Overview","href":"/api-reference/ai-referrals/overview"},{"title":"Register AI Referrals Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/ai-referrals/connections","href":"/api-reference/ai-referrals/register-ai-referrals-connection"},{"title":"List AI Referrals Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/ai-referrals/connections","href":"/api-reference/ai-referrals/list-ai-referrals-connections"},{"title":"Disable AI Referrals Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/ai-referrals/connections/{connection_id}","href":"/api-reference/ai-referrals/disable-ai-referrals-connection"},{"title":"Push AI Referrals Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/ai-referrals/connections/{connection_id}/events","href":"/api-reference/ai-referrals/push-ai-referrals-events"}]},{"group":"Collection API","pages":[{"title":"Create Collection Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/collections","href":"/api-reference/create-collection-request"}]}]},{"group":"Optimize","icon":"wand-magic-sparkles","pages":[{"group":"Site Optimization API","pages":[{"title":"Site Optimization API: Recommendations, by type and by page","sidebarTitle":"Overview","href":"/api-reference/site-optimization/overview"},{"title":"List Recommendation Types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-type","href":"/api-reference/site-optimization/list-recommendation-types"},{"title":"Get Recommendation Type Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-type/{best_practice_id}","href":"/api-reference/site-optimization/get-recommendation-type-detail"},{"title":"List Page Recommendations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-page","href":"/api-reference/site-optimization/list-page-recommendations"},{"title":"Get Page Optimization Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/optimization","href":"/api-reference/site-optimization/get-page-optimization-detail"},{"title":"Apply Page Optimization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/site-optimization/optimization/apply","href":"/api-reference/site-optimization/apply-page-optimization"}]},{"group":"Audit Scores API","pages":[{"title":"Audit Scores API: Retrievability and citability by page","description":"Read a brand's AI-visibility scores — retrievability and citability — rolled up for the whole site and broken out per page, with the headroom left on each.","sidebarTitle":"Overview","href":"/api-reference/audit-scores/overview"},{"title":"Get Site Audit Score","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/site","href":"/api-reference/audit-scores/get-site-audit-score"},{"title":"List Page Audit Scores","description":"The latest AI-visibility score per page for a brand — retrievability and citability, each page's `url`, when it was scored (`generated_at`), its headroom (open work by severity), and the sitemap page it maps to (`mapped_page_id`, null when unmatched).\n\nPage through the whole brand with `limit` (max 1000) and `offset`. Ordered by page `url` (stable for pagination), not by score.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/pages","href":"/api-reference/audit-scores/list-page-audit-scores"}]},{"group":"Crawl Readiness API","public":true,"pages":[{"title":"Crawl Readiness API: Check AI Crawler Access to a Site","sidebarTitle":"Overview","href":"/api-reference/crawl-readiness/overview"},{"title":"Get AI Crawl Readiness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/crawl-readiness","href":"/api-reference/crawl-readiness/get-ai-crawl-readiness"}]}]},{"group":"Deliver","icon":"paper-plane","pages":[{"group":"Agent Pages","pages":[{"title":"Agent Pages Force Refresh: Update Pages on Demand","sidebarTitle":"Force Refresh overview","href":"/api-reference/agent-pages/force-refresh-overview"},{"title":"Force Refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/refresh","href":"/api-reference/agent-pages/force-refresh"},{"title":"Agent Pages Unpublish: Stop Serving Pages on Demand","sidebarTitle":"Unpublish overview","href":"/api-reference/agent-pages/unpublish-overview"},{"title":"Unpublish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/unpublish","href":"/api-reference/agent-pages/unpublish"},{"title":"Agent Pages Publish: Add Pages on Demand","sidebarTitle":"Publish overview","href":"/api-reference/agent-pages/publish-overview"},{"title":"Publish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/publish","href":"/api-reference/agent-pages/publish"}]},{"group":"Curated Pages (AXP)","pages":[{"title":"AXP Unpublish API: Take Optimized Pages Off the Edge","sidebarTitle":"Unpublish overview","href":"/api-reference/axp/unpublish"},{"title":"Unpublish Optimized Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/unpublish/{brand_id}/sites/{site_id}","href":"/api-reference/axp-render/unpublish-optimized-pages"}]}]},{"group":"Configure","icon":"gear","pages":[{"group":"Configuration API","public":true,"pages":[{"title":"Configuration API: Manage Brands and Prompts","sidebarTitle":"Overview","href":"/api-reference/configuration/overview"},{"title":"List Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands","href":"/api-reference/list-brands"},{"title":"List Sites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sites","href":"/api-reference/agent-pages/list-sites"},{"title":"Create Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands","href":"/api-reference/create-brand"},{"title":"Update Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /brands/{brand_id}","href":"/api-reference/update-brand"},{"title":"List Competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/competitors","href":"/api-reference/list-competitors"},{"title":"Get Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/get-competitor"},{"title":"Create Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands/{brand_id}/competitors","href":"/api-reference/create-competitor"},{"title":"Update Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/update-competitor"},{"title":"Archive Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/archive-competitor"},{"title":"List Personas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/personas","href":"/api-reference/list-personas"},{"title":"Get Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/get-persona"},{"title":"Create Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands/{brand_id}/personas","href":"/api-reference/create-persona"},{"title":"Update Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/update-persona"},{"title":"Archive Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/archive-persona"},{"title":"List Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/prompts","href":"/api-reference/list-prompts"},{"title":"Create Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/prompts","href":"/api-reference/create-prompt"},{"title":"Update Prompt Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /{brand_id}/prompts/{prompt_id}","href":"/api-reference/update-prompt-status"},{"title":"Archive Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/prompts/{prompt_id}","href":"/api-reference/archive-prompt"}]},{"group":"Account API","public":true,"pages":[{"title":"Account API: Read the Subscription State of an API Key","sidebarTitle":"Overview","href":"/api-reference/account/overview"},{"title":"Get Account Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /account","href":"/api-reference/account/get-account-status"}]},{"group":"Webhooks","public":true,"pages":[{"title":"Webhooks: Pipeline Stage Completion Callbacks","sidebarTitle":"Overview","href":"/api-reference/webhooks/overview"}]}]},{"group":"Deprecated","icon":"box-archive","pages":[{"group":"Site Audit API","public":true,"tag":"Deprecated","pages":[{"title":"Site Audit API: Score pages for AI search readiness","sidebarTitle":"Overview","href":"/api-reference/site-audit/overview"},{"title":"Create Page Audits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/page-audits","href":"/api-reference/create-page-audits"},{"title":"List Page Audits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/page-audits","href":"/api-reference/list-page-audits"},{"title":"Get Page Audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/page-audits/{page_audit_id}","href":"/api-reference/get-page-audit"}]},{"group":"Sitemap API","public":true,"tag":"Deprecated","pages":[{"title":"Sitemap API: Pages, Audit Scores, AI Metrics","sidebarTitle":"Overview","href":"/api-reference/sitemap/overview"},{"title":"List Sitemap Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages","href":"/api-reference/sitemap/list-sitemap-pages"},{"title":"Get Sitemap Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages/{page_id}","href":"/api-reference/sitemap/get-sitemap-page"},{"title":"Get Sitemap Page Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages/{page_id}/metrics","href":"/api-reference/sitemap/get-sitemap-page-metrics"},{"title":"Export Sitemap Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/export","href":"/api-reference/sitemap/export-sitemap-pages"}]},{"group":"AXP Render API","public":true,"tag":"Deprecated","pages":[{"title":"AXP Render API: Queue Optimized Page Renders","sidebarTitle":"Overview","href":"/api-reference/axp/overview"},{"title":"Bulk Render Optimized Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/render-bulk/{brand_id}/sites/{site_id}","href":"/api-reference/axp-render/bulk-render-optimized-pages"}]},{"group":"Optimize \u0026 Deploy API","public":true,"tag":"Deprecated","pages":[{"title":"Optimize and Deploy Pipeline API Overview","sidebarTitle":"Overview","href":"/api-reference/orchestration/overview"},{"title":"Create Optimize And Deploy Pipeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/optimize-and-deploy/{brand_id}","href":"/api-reference/orchestration/create-optimize-and-deploy-pipeline"},{"title":"Get Pipeline Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /orchestration/optimize-and-deploy/{brand_id}/{token}","href":"/api-reference/orchestration/get-pipeline-status"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Get Site Audit Score - Scrunch API Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}