{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"chatobserver","description":"Learn AI visibility tracking, competitor analysis, sentiment, source citations, reporting, and the chatobserver API.","colors":{"primary":"#FF0080","light":"#FF0080","dark":"#FF0080"},"logo":{"light":"https://mintcdn.com/chatobserverltd/5Yfvp5xLWzwKiCcC/images/documentation/brand/chatobserver-wordmark-on-light.svg?fit=max\u0026auto=format\u0026n=5Yfvp5xLWzwKiCcC\u0026q=85\u0026s=4348fcdf569575a6adeb05275a9e8486","dark":"https://mintcdn.com/chatobserverltd/5Yfvp5xLWzwKiCcC/images/documentation/brand/chatobserver-wordmark-on-dark.svg?fit=max\u0026auto=format\u0026n=5Yfvp5xLWzwKiCcC\u0026q=85\u0026s=b8915f1a87f943c0bfde7ddcd9dcb858","href":"/"},"favicon":{"light":"https://mintcdn.com/chatobserverltd/5Yfvp5xLWzwKiCcC/images/documentation/brand/chatobserver-mark-on-light.svg?fit=max\u0026auto=format\u0026n=5Yfvp5xLWzwKiCcC\u0026q=85\u0026s=14a55c27b4457da59b8f43f68d276b8e","dark":"https://mintcdn.com/chatobserverltd/5Yfvp5xLWzwKiCcC/images/documentation/brand/chatobserver-mark-on-dark.svg?fit=max\u0026auto=format\u0026n=5Yfvp5xLWzwKiCcC\u0026q=85\u0026s=d9c83616cdc4bf67ee5262247e0ec15c"},"api":{"openapi":"openapi.json","params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python"],"autogenerate":true},"mdx":{"server":"https://app.chatobserver.com"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FFFFFF","dark":"#111111"}},"navbar":{"links":[{"href":"https://chatobserver.com","label":"Website"}],"primary":{"type":"button","label":"Open dashboard","href":"https://app.chatobserver.com/dashboard"}},"footer":{"links":[{"header":"chatobserver","items":[{"label":"Support","href":"mailto:support@chatobserver.com"},{"label":"Privacy","href":"https://chatobserver.com/privacy"},{"label":"Terms","href":"https://chatobserver.com/terms"}]}]},"search":{"prompt":"Search documentation…"},"seo":{"indexing":"navigable"},"fonts":{"family":"Figtree"},"contextual":{"options":["copy","view","download-spec"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatobserverltd","hasAudioNarration":false,"actualSubdomain":"chatobserverltd","customDomains":["chatobserver.com"],"gitSource":{"type":"github","owner":"alex-berish","repo":"chatobserver","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc8e2b50fd02f25b793000","collectionId":"45f7a06e-c9d0-487c-b53f-87297001514a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc8e2b50fd02f25b793000"},"entitlements":{},"buildId":"6ade9e9fb128bc39b5e7138e","clientVersion":"0.0.3969","searchFilterCounts":[{"language":"default","tag":"API reference","count":305},{"language":"default","tag":"Endpoint reference","count":294},{"language":"default","tag":"Documentation","count":47},{"language":"default","tag":"Prompts","count":43},{"language":"default","tag":"Reports","count":34},{"language":"default","tag":"Spreadsheet clients","count":34},{"language":"default","tag":"Brands","count":25},{"language":"default","tag":"Data delivery","count":25},{"language":"default","tag":"Visitor analytics","count":25},{"language":"default","tag":"Answers","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","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":"editor-agent-model-picker","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":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues","slug":"/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues","pageMetadata":{"title":"List source catalogues","description":"Access document-bound client sessions, queries, schedules, bindings and write claims.","openapi":"GET /api/v2/metrics/client/catalogues","canonical":"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues"},"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: \"Access document-bound client sessions, queries, schedules, bindings and write claims.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Required scopes: `,_jsx(_components.code,{children:`client:read`}),`.`]})}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":"List source catalogues","description":"Access document-bound client sessions, queries, schedules, bindings and write claims.","openapi":"GET /api/v2/metrics/client/catalogues","canonical":"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getV2MetricsClientCatalogues","tags":["Spreadsheet clients"],"summary":"List source catalogues","description":"Access document-bound client sessions, queries, schedules, bindings and write claims.","parameters":["7a155eb3-f543-4d44-9a03-e297e10a837b","00137962-0376-426b-b79c-cfa404de53a8"],"responses":{"200":"e1fe187c-a956-4472-aa3b-f900bf646360","default":"d2083e2c-7f7a-41df-a2a4-0b578fc13d23"},"x-required-scopes":["client:read"],"security":["f828ddb3-abfc-456c-ba0c-7d113e05c491"],"method":"get","type":"path","servers":["dc5864fd-b080-43cd-863d-75c025173387"],"path":"/api/v2/metrics/client/catalogues","baseUrlOptions":["https://app.chatobserver.com"],"title":"List source catalogues","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7a155eb3-f543-4d44-9a03-e297e10a837b":{"name":"x-metrics-client-audience","in":"header","required":true,"schema":{"enum":["chatobserver-metrics-sheets","chatobserver-metrics-excel"],"type":"string","isRequired":true,"description":"The audience bound to the authorised client session.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"The audience bound to the authorised client session."},"00137962-0376-426b-b79c-cfa404de53a8":{"name":"x-metrics-document-reference","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$","isRequired":true,"description":"The document reference hash bound to the client session.","uniqueKey":"","typeLabel":"string"},"description":"The document reference hash bound to the client session."}},"responses":{"e1fe187c-a956-4472-aa3b-f900bf646360":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"snapshots":{"type":"array","items":{"type":"object","properties":{"sourceAccountId":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].sourceAccountId","typeLabel":"string"},"queryTypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].label","typeLabel":"string"},"description":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].description","typeLabel":"string"},"providerResource":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].providerResource","typeLabel":"string"},"grain":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].grain","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","const":false,"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].default.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].default.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX].default","typeLabel":"boolean"}},"required":["id","label"],"uniqueKey":"data.snapshots.items.[INDEX].queryTypes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryTypes","typeLabel":"object[]"},"queryOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].label","typeLabel":"string"},"type":{"enum":["boolean","enum"],"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].description","typeLabel":"string"},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].values.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].values.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].values","typeLabel":"object[]"},"required":{"oneOf":[{"type":"boolean","const":false,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].required.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].required.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].required","typeLabel":"boolean"},"defaultValue":{"oneOf":[{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].defaultValue.oneOf.0","typeLabel":"string"},{"type":"boolean","const":false,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].defaultValue.oneOf.1","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].defaultValue.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX].defaultValue","typeLabel":"string · boolean · boolean"}},"required":["id","label","type"],"uniqueKey":"data.snapshots.items.[INDEX].queryOptions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].queryOptions","typeLabel":"object[]"},"limits":{"type":"object","properties":{"maximumDimensions":{"type":"number","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].limits.maximumDimensions","typeLabel":"number"},"maximumMetrics":{"type":"number","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].limits.maximumMetrics","typeLabel":"number"},"maximumRows":{"type":"number","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].limits.maximumRows","typeLabel":"number"}},"required":["maximumDimensions","maximumMetrics","maximumRows"],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].limits","typeLabel":"object"},"capabilities":{"type":"object","properties":{"queryOrdering":{"enum":["provider","none"],"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.queryOrdering","typeLabel":"enum\u003cstring>"},"supportsMetricFilters":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMetricFilters.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMetricFilters.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMetricFilters","typeLabel":"boolean"},"supportsMultipleDateRanges":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleDateRanges.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleDateRanges.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleDateRanges","typeLabel":"boolean"},"supportsComparisons":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsComparisons.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsComparisons.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsComparisons","typeLabel":"boolean"},"supportsPivots":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsPivots.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsPivots.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsPivots","typeLabel":"boolean"},"supportsMultipleAccounts":{"oneOf":[{"type":"boolean","const":false,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleAccounts.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleAccounts.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsMultipleAccounts","typeLabel":"boolean"},"supportsNestedFilters":{"oneOf":[{"type":"boolean","const":false,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsNestedFilters.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsNestedFilters.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"data.snapshots.items.[INDEX].capabilities.supportsNestedFilters","typeLabel":"boolean"}},"required":["queryOrdering","supportsMetricFilters","supportsMultipleDateRanges","supportsComparisons","supportsPivots"],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].capabilities","typeLabel":"object"},"reportingLagDays":{"type":"number","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].reportingLagDays","typeLabel":"number"},"completenessNote":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].completenessNote.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].completenessNote.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].completenessNote","typeLabel":"null | string"},"snapshot":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.id","typeLabel":"string"},"expiresAt":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.expiresAt.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.expiresAt.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.expiresAt","typeLabel":"null | string"},"workspaceId":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.workspaceId.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.workspaceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.workspaceId","typeLabel":"null | string"},"fingerprint":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fingerprint","typeLabel":"string"},"connectorKey":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.connectorKey","typeLabel":"string"},"discoveredAt":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.discoveredAt","typeLabel":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["string","number","boolean","integer","date","json","duration","url","percent","currency","datetime","decimal","image_url"],"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].id","typeLabel":"string"},"description":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].description.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].description.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].description","typeLabel":"null | string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].label","typeLabel":"string"},"role":{"enum":["metric","dimension","identifier","attribute"],"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"providerFieldId":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].providerFieldId","typeLabel":"string"},"aggregation":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].aggregation.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].aggregation.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].aggregation","typeLabel":"null | string"},"compatibleFieldIds":{"type":"array","items":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].compatibleFieldIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].compatibleFieldIds","typeLabel":"string[]"},"supportedFilterOperators":{"type":"array","items":{"enum":["equals","not_equals","contains","greater_than","less_than","in","between","is_null","is_not_null","not_in","not_contains","starts_with","ends_with","regex","not_regex","greater_than_or_equal","less_than_or_equal"],"type":"string","uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].supportedFilterOperators.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].supportedFilterOperators","typeLabel":"enum\u003cstring>[]"},"semanticTags":{"type":"array","items":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].semanticTags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].semanticTags","typeLabel":"string[]"},"queryTypeIds":{"type":"array","items":{"type":"string","uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].queryTypeIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].queryTypeIds","typeLabel":"string[]"},"hidden":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].hidden.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].hidden.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].hidden","typeLabel":"boolean"},"deprecated":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].deprecated.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].deprecated.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX].deprecated","typeLabel":"boolean"}},"required":["type","id","description","label","role","providerFieldId","aggregation","compatibleFieldIds","supportedFilterOperators","semanticTags","queryTypeIds","hidden","deprecated"],"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.fields","typeLabel":"object[]"},"queryType":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.queryType","typeLabel":"string"},"providerSchemaVersion":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.providerSchemaVersion.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.providerSchemaVersion.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot.providerSchemaVersion","typeLabel":"null | string"}},"required":["id","expiresAt","workspaceId","fingerprint","connectorKey","discoveredAt","fields","queryType","providerSchemaVersion"],"isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].snapshot","typeLabel":"object"},"status":{"type":"string","isRequired":true,"uniqueKey":"data.snapshots.items.[INDEX].status","typeLabel":"string"}},"required":["sourceAccountId","queryTypes","queryOptions","limits","capabilities","reportingLagDays","completenessNote","snapshot","status"],"uniqueKey":"data.snapshots.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.snapshots","typeLabel":"object[]"},"changes":{"type":"array","items":{"type":"object","properties":{"sourceAccountId":{"type":"string","isRequired":true,"uniqueKey":"data.changes.items.[INDEX].sourceAccountId","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"data.changes.items.[INDEX].createdAt","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.changes.items.[INDEX].id","typeLabel":"string"},"addedFieldIds":{"type":"array","items":{"type":"string","uniqueKey":"data.changes.items.[INDEX].addedFieldIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.changes.items.[INDEX].addedFieldIds","typeLabel":"string[]"},"removedFieldIds":{"type":"array","items":{"type":"string","uniqueKey":"data.changes.items.[INDEX].removedFieldIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.changes.items.[INDEX].removedFieldIds","typeLabel":"string[]"},"changedFieldIds":{"type":"array","items":{"type":"string","uniqueKey":"data.changes.items.[INDEX].changedFieldIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.changes.items.[INDEX].changedFieldIds","typeLabel":"string[]"},"affectedQueryCount":{"type":"number","isRequired":true,"uniqueKey":"data.changes.items.[INDEX].affectedQueryCount","typeLabel":"number"}},"required":["sourceAccountId","createdAt","id","addedFieldIds","removedFieldIds","changedFieldIds","affectedQueryCount"],"uniqueKey":"data.changes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.changes","typeLabel":"object[]"}},"required":["snapshots","changes"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"snapshots":[{"sourceAccountId":"\u003cstring>","queryTypes":[{"id":"\u003cstring>","label":"\u003cstring>","description":"\u003cstring>","providerResource":"\u003cstring>","grain":"\u003cstring>","default":false}],"queryOptions":[{"id":"\u003cstring>","label":"\u003cstring>","type":"boolean","description":"\u003cstring>","values":[{"value":"\u003cstring>","label":"\u003cstring>"}],"required":false,"defaultValue":"\u003cstring>"}],"limits":{"maximumDimensions":123,"maximumMetrics":123,"maximumRows":123},"capabilities":{"queryOrdering":"provider","supportsMetricFilters":false,"supportsMultipleDateRanges":false,"supportsComparisons":false,"supportsPivots":false,"supportsMultipleAccounts":false,"supportsNestedFilters":false},"reportingLagDays":123,"completenessNote":"\u003cstring>","snapshot":{"id":"\u003cstring>","expiresAt":"\u003cstring>","workspaceId":"\u003cstring>","fingerprint":"\u003cstring>","connectorKey":"\u003cstring>","discoveredAt":"\u003cstring>","fields":[{"type":"string","id":"\u003cstring>","description":"\u003cstring>","label":"\u003cstring>","role":"metric","providerFieldId":"\u003cstring>","aggregation":"\u003cstring>","compatibleFieldIds":["\u003cstring>"],"supportedFilterOperators":["equals"],"semanticTags":["\u003cstring>"],"queryTypeIds":["\u003cstring>"],"hidden":false,"deprecated":false}],"queryType":"\u003cstring>","providerSchemaVersion":"\u003cstring>"},"status":"\u003cstring>"}],"changes":[{"sourceAccountId":"\u003cstring>","createdAt":"\u003cstring>","id":"\u003cstring>","addedFieldIds":["\u003cstring>"],"removedFieldIds":["\u003cstring>"],"changedFieldIds":["\u003cstring>"],"affectedQueryCount":123}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"d2083e2c-7f7a-41df-a2a4-0b578fc13d23":{"description":"Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["internal","validation_failed","authentication_required","forbidden","not_found","conflict","precondition_failed","idempotency_conflict","capability_unavailable","connection_unavailable","reauthentication_required","provider_rate_limited","workspace_limit_exceeded","result_expired","operation_failed","temporarily_unavailable"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"fieldPath":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.fieldPath.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.fieldPath.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.fieldPath.items.[INDEX]","typeLabel":"string | number"},"isRequired":true,"uniqueKey":"error.fieldPath","typeLabel":"(string | number)[]"},"parameters":{"type":"object","properties":{},"additionalProperties":{"oneOf":[{"type":"null","uniqueKey":"error.parameters.additionalProperties.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"error.parameters.additionalProperties.oneOf.1","typeLabel":"string"},{"type":"number","uniqueKey":"error.parameters.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","const":false,"uniqueKey":"error.parameters.additionalProperties.oneOf.3","typeLabel":"boolean"},{"type":"boolean","const":true,"uniqueKey":"error.parameters.additionalProperties.oneOf.4","typeLabel":"boolean"}],"uniqueKey":"error.parameters.additionalProperties","typeLabel":"null · string · number · boolean · boolean"},"isRequired":true,"uniqueKey":"error.parameters","typeLabel":"object"},"repairActions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":96,"uniqueKey":"error.repairActions.items.[INDEX]","typeLabel":"string"},"maxItems":10,"isRequired":true,"uniqueKey":"error.repairActions","typeLabel":"string[]"},"requestId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryable":{"oneOf":[{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"error.retryable.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"error.retryAfterSeconds.oneOf.0","typeLabel":"null"},{"type":"integer","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"error.retryAfterSeconds.oneOf.1","typeLabel":"integer"}],"isRequired":true,"uniqueKey":"error.retryAfterSeconds","typeLabel":"null | integer"}},"required":["code","fieldPath","parameters","repairActions","requestId","retryable","retryAfterSeconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal","fieldPath":["\u003cstring>"],"parameters":{},"repairActions":["\u003cstring>"],"requestId":"\u003cstring>","retryable":false,"retryAfterSeconds":1}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f828ddb3-abfc-456c-ba0c-7d113e05c491":{"ClientSession":{"type":"http","scheme":"bearer","description":"A client session token obtained through the client authorisation challenge flow.","scopes":[],"schemeName":"ClientSession"}}},"servers":{"dc5864fd-b080-43cd-863d-75c025173387":{"url":"https://app.chatobserver.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A client session token obtained through the client authorisation challenge flow.","scopes":[],"schemeName":"ClientSession"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A client session token obtained through the client authorisation challenge flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ClientSession","name":"Authorization"}],"title":"ClientSession"}]},"originalFileLocation":"openapi.json"},"subdomain":"chatobserverltd","siteName":"chatobserver","title":"List source catalogues - chatobserver","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-11T00:00:11.386Z","originalFileLocation":"api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues.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=\"Access document-bound client sessions, queries, schedules, bindings and write claims.\">\u003cmeta data-mint-head name=\"application-name\" content=\"chatobserver\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_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=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List source catalogues - chatobserver\">\u003cmeta data-mint-head property=\"og:description\" content=\"Access document-bound client sessions, queries, schedules, bindings and write claims.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"chatobserver\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatobserverltd.mintlify.app/_mintlify/api/og/v2?division=Spreadsheet+clients\u0026amp;title=List+source+catalogues\u0026amp;description=Access+document-bound+client+sessions%2C+queries%2C+schedules%2C+bindings+and+write+claims.\u0026amp;theme=03dba9043dcffef3dc081456\u0026amp;signature=bc10d6ce11b20167a2a269532f8b1b6e55b89b5f90b3976b0908337e0e8898f6\">\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=\"List source catalogues - chatobserver\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Access document-bound client sessions, queries, schedules, bindings and write claims.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatobserverltd.mintlify.app/_mintlify/api/og/v2?division=Spreadsheet+clients\u0026amp;title=List+source+catalogues\u0026amp;description=Access+document-bound+client+sessions%2C+queries%2C+schedules%2C+bindings+and+write+claims.\u0026amp;theme=03dba9043dcffef3dc081456\u0026amp;signature=bc10d6ce11b20167a2a269532f8b1b6e55b89b5f90b3976b0908337e0e8898f6\">\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=\"/docs/mintlify-assets/_mintlify/favicons/chatobserverltd/TflDjjHcfvn-aVZA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"chatobserver\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF0080\">\u003clink data-mint-head rel=\"canonical\" href=\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://chatobserver.com/#organization\",\"name\":\"chatobserver\",\"url\":\"https://chatobserver.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatobserverltd/5Yfvp5xLWzwKiCcC/images/documentation/brand/chatobserver-wordmark-on-light.svg?fit=max\u0026auto=format\u0026n=5Yfvp5xLWzwKiCcC\u0026q=85\u0026s=4348fcdf569575a6adeb05275a9e8486\"}},{\"@type\":\"WebSite\",\"@id\":\"https://chatobserver.com/docs#website\",\"name\":\"chatobserver\",\"url\":\"https://chatobserver.com/docs\",\"publisher\":{\"@id\":\"https://chatobserver.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues#webpage\",\"url\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues\",\"name\":\"List source catalogues\",\"description\":\"Access document-bound client sessions, queries, schedules, bindings and write claims.\",\"dateModified\":\"2026-09-11T00:00:11.386Z\",\"isPartOf\":{\"@id\":\"https://chatobserver.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint reference\",\"item\":\"https://chatobserver.com/docs/api-reference/workspace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Spreadsheet clients\",\"item\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List source catalogues\",\"item\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues#apireference\",\"headline\":\"List source catalogues\",\"name\":\"List source catalogues\",\"description\":\"Access document-bound client sessions, queries, schedules, bindings and write claims.\",\"url\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues\",\"mainEntityOfPage\":{\"@id\":\"https://chatobserver.com/docs/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues#webpage\"},\"dateModified\":\"2026-09-11T00:00:11.386Z\",\"publisher\":{\"@id\":\"https://chatobserver.com/#organization\"},\"isPartOf\":{\"@id\":\"https://chatobserver.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"chatobserver\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"chatobserver","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Integration guides","pages":[{"title":"How do I authenticate with the chatobserver API?","sidebarTitle":"Authentication and scopes","href":"/developers/authentication"},{"title":"How do I paginate and filter chatobserver API results?","sidebarTitle":"Pagination and filters","href":"/developers/pagination-and-filters"},{"title":"How do I handle chatobserver API errors and rate limits?","sidebarTitle":"Errors and rate limits","href":"/developers/errors-and-rate-limits"},{"title":"How do I safely retry API requests that change data?","sidebarTitle":"Safe writes and retries","href":"/developers/safe-writes"},{"title":"How do I create and run AI monitoring prompts through the API?","sidebarTitle":"Create and run prompts","href":"/developers/manage-prompts"},{"title":"How do I export AI answers, sentiment, and citations through the API?","sidebarTitle":"Export answers and citations","href":"/developers/export-answers"},{"title":"How do I use the chatobserver Data API?","sidebarTitle":"Data API access","href":"/developers/data-api"},{"title":"How do I follow Data API operations and receive webhooks?","sidebarTitle":"Operations and webhooks","href":"/developers/data-operations"},{"title":"How do I generate AI visibility reports through the API?","sidebarTitle":"Website audit API","href":"/developers/website-audits"},{"title":"How do I authorise a spreadsheet client to use chatobserver data?","sidebarTitle":"Spreadsheet authorisation","href":"/developers/spreadsheet-authorisation"},{"title":"How do I version and publish reusable Data API definitions?","sidebarTitle":"Definitions and versions","href":"/developers/definitions-and-versions"}]},{"group":"Endpoint reference","pages":[{"group":"Workspace","pages":[{"title":"How do I validate API access and find my workspace project?","sidebarTitle":"Workspace","href":"/api-reference/workspace"},{"title":"List AI platforms","openapi":"GET /api/v2/models","href":"/api-reference/workspace/get-v2-models"},{"title":"List workspace projects","openapi":"GET /api/v2/projects","href":"/api-reference/workspace/get-v2-projects"},{"title":"Validate API access","openapi":"GET /api/v2/validate","href":"/api-reference/workspace/get-v2-validate"},{"title":"Get domain visibility totals","openapi":"GET /api/v2/visibility/domain-rollups","href":"/api-reference/workspace/get-v2-visibility-domain-rollups"}]},{"group":"Prompts","pages":[{"title":"How do I manage AI tracking prompts through the API?","sidebarTitle":"Prompts","href":"/api-reference/prompts"},{"title":"List personas","openapi":"GET /api/v2/personas","href":"/api-reference/prompts/get-v2-personas"},{"title":"Create a persona","openapi":"POST /api/v2/personas","href":"/api-reference/prompts/post-v2-personas"},{"title":"List monitoring prompts","openapi":"GET /api/v2/prompts","href":"/api-reference/prompts/get-v2-prompts"},{"title":"Create a monitoring prompt","openapi":"POST /api/v2/prompts","href":"/api-reference/prompts/post-v2-prompts"},{"title":"List prompt groups","openapi":"GET /api/v2/tags","href":"/api-reference/prompts/get-v2-tags"},{"title":"Create a prompt group","openapi":"POST /api/v2/tags","href":"/api-reference/prompts/post-v2-tags"},{"title":"Get a persona","openapi":"GET /api/v2/personas/{id}","href":"/api-reference/prompts/get-v2-personas-id"},{"title":"Update a persona","openapi":"PUT /api/v2/personas/{id}","href":"/api-reference/prompts/put-v2-personas-id"},{"title":"Delete a persona","openapi":"DELETE /api/v2/personas/{id}","href":"/api-reference/prompts/delete-v2-personas-id"},{"title":"Get a monitoring prompt","openapi":"GET /api/v2/prompts/{id}","href":"/api-reference/prompts/get-v2-prompts-id"},{"title":"Update a monitoring prompt","openapi":"PUT /api/v2/prompts/{id}","href":"/api-reference/prompts/put-v2-prompts-id"},{"title":"Delete a monitoring prompt","openapi":"DELETE /api/v2/prompts/{id}","href":"/api-reference/prompts/delete-v2-prompts-id"},{"title":"Activate monitoring prompts","openapi":"PATCH /api/v2/prompts/activate","href":"/api-reference/prompts/patch-v2-prompts-activate"},{"title":"Create multiple monitoring prompts","openapi":"POST /api/v2/prompts/bulk","href":"/api-reference/prompts/post-v2-prompts-bulk"},{"title":"Delete multiple monitoring prompts","openapi":"DELETE /api/v2/prompts/bulk","href":"/api-reference/prompts/delete-v2-prompts-bulk"},{"title":"Pause monitoring prompts","openapi":"PATCH /api/v2/prompts/deactivate","href":"/api-reference/prompts/patch-v2-prompts-deactivate"},{"title":"Update a prompt group","openapi":"PATCH /api/v2/tags/{id}","href":"/api-reference/prompts/patch-v2-tags-id"},{"title":"Delete a prompt group","openapi":"DELETE /api/v2/tags/{id}","href":"/api-reference/prompts/delete-v2-tags-id"},{"title":"Run a prompt now","openapi":"POST /api/v2/prompts/{id}/rerun","href":"/api-reference/prompts/post-v2-prompts-id-rerun"},{"title":"Assign groups to a prompt","openapi":"POST /api/v2/prompts/{id}/tags","href":"/api-reference/prompts/post-v2-prompts-id-tags"},{"title":"Assign groups to multiple prompts","openapi":"POST /api/v2/prompts/tags/bulk","href":"/api-reference/prompts/post-v2-prompts-tags-bulk"},{"title":"List prompt groups","openapi":"GET /api/v2/groups","href":"/api-reference/prompts/get-v2-groups"},{"title":"Create a prompt group","openapi":"POST /api/v2/groups","href":"/api-reference/prompts/post-v2-groups"},{"title":"Read a prompt group","openapi":"GET /api/v2/groups/{id}","href":"/api-reference/prompts/get-v2-groups-id"},{"title":"Edit or archive a prompt group","openapi":"PATCH /api/v2/groups/{id}","href":"/api-reference/prompts/patch-v2-groups-id"},{"title":"Change prompt group membership","openapi":"PATCH /api/v2/groups/{id}/memberships","href":"/api-reference/prompts/patch-v2-groups-id-memberships"},{"title":"Archive monitoring prompts","openapi":"PATCH /api/v2/prompts/archive","href":"/api-reference/prompts/patch-v2-prompts-archive"},{"title":"Unarchive monitoring prompts","openapi":"PATCH /api/v2/prompts/unarchive","href":"/api-reference/prompts/patch-v2-prompts-unarchive"},{"title":"Read group comparisons and grouping opportunities","openapi":"GET /api/v2/groups/overview","href":"/api-reference/prompts/get-v2-groups-overview"},{"title":"Read group visibility, sources and evidence","openapi":"GET /api/v2/groups/{id}/analytics","href":"/api-reference/prompts/get-v2-groups-id-analytics"},{"title":"List grouping rules","openapi":"GET /api/v2/groups/rules","href":"/api-reference/prompts/get-v2-groups-rules"},{"title":"Create a reviewed grouping rule","openapi":"POST /api/v2/groups/rules","href":"/api-reference/prompts/post-v2-groups-rules"},{"title":"Preview a grouping rule","openapi":"POST /api/v2/groups/rules/preview","href":"/api-reference/prompts/post-v2-groups-rules-preview"},{"title":"Edit or pause a grouping rule","openapi":"PATCH /api/v2/groups/rules/{ruleId}","href":"/api-reference/prompts/patch-v2-groups-rules-rule-id"},{"title":"Archive a grouping rule","openapi":"POST /api/v2/groups/rules/{ruleId}/archive","href":"/api-reference/prompts/post-v2-groups-rules-rule-id-archive"},{"title":"Read prompt visibility and comparisons","openapi":"GET /api/v2/prompts/{id}/analytics","href":"/api-reference/prompts/get-v2-prompts-id-analytics"},{"title":"Read prompt source popularity","openapi":"GET /api/v2/prompts/popularity","href":"/api-reference/prompts/get-v2-prompts-popularity"},{"title":"Read your prompt drafts","openapi":"GET /api/v2/prompts/drafts","href":"/api-reference/prompts/get-v2-prompts-drafts"},{"title":"Save a personal prompt draft","openapi":"PUT /api/v2/prompts/drafts","href":"/api-reference/prompts/put-v2-prompts-drafts"},{"title":"Remove a personal prompt draft","openapi":"DELETE /api/v2/prompts/drafts","href":"/api-reference/prompts/delete-v2-prompts-drafts"},{"title":"Read the filtered prompt inventory","openapi":"GET /api/v2/prompts/inventory","href":"/api-reference/prompts/get-v2-prompts-inventory"},{"title":"Apply or dismiss a grouping opportunity","openapi":"POST /api/v2/groups/opportunities","href":"/api-reference/prompts/post-v2-groups-opportunities"}]},{"group":"Answers","pages":[{"title":"How do I retrieve AI answers and sentiment through the API?","sidebarTitle":"Answers","href":"/api-reference/answers"},{"title":"List AI answers","openapi":"GET /api/v2/responses","href":"/api-reference/answers/get-v2-responses"},{"title":"Get an AI answer","openapi":"GET /api/v2/responses/{id}","href":"/api-reference/answers/get-v2-responses-id"},{"title":"Compare competitors in AI answers","openapi":"GET /api/v2/responses/competitors","href":"/api-reference/answers/get-v2-responses-competitors"},{"title":"Track brand mentions over time","openapi":"GET /api/v2/responses/mentions-time-series","href":"/api-reference/answers/get-v2-responses-mentions-time-series"},{"title":"Get the sentiment distribution","openapi":"GET /api/v2/responses/sentiment-distribution","href":"/api-reference/answers/get-v2-responses-sentiment-distribution"},{"title":"Track sentiment over time","openapi":"GET /api/v2/responses/sentiment-over-time","href":"/api-reference/answers/get-v2-responses-sentiment-over-time"},{"title":"Get an AI answer summary","openapi":"GET /api/v2/responses/summary","href":"/api-reference/answers/get-v2-responses-summary"},{"title":"Read sentiment overview","openapi":"GET /api/v2/sentiment/overview","href":"/api-reference/answers/get-v2-sentiment-overview"},{"title":"Read sentiment series","openapi":"GET /api/v2/sentiment/series","href":"/api-reference/answers/get-v2-sentiment-series"},{"title":"Read sentiment models","openapi":"GET /api/v2/sentiment/models","href":"/api-reference/answers/get-v2-sentiment-models"},{"title":"Read sentiment brands","openapi":"GET /api/v2/sentiment/brands","href":"/api-reference/answers/get-v2-sentiment-brands"},{"title":"Read sentiment aspects","openapi":"GET /api/v2/sentiment/aspects","href":"/api-reference/answers/get-v2-sentiment-aspects"},{"title":"Read sentiment evidence","openapi":"GET /api/v2/sentiment/evidence","href":"/api-reference/answers/get-v2-sentiment-evidence"}]},{"group":"Brands","pages":[{"title":"How do I compare brand visibility through the API?","sidebarTitle":"Brands","href":"/api-reference/brands"},{"title":"List brands","openapi":"GET /api/v2/brands","href":"/api-reference/brands/get-v2-brands"},{"title":"Create a brand","openapi":"POST /api/v2/brands","href":"/api-reference/brands/post-v2-brands"},{"title":"Get competitor heatmap","openapi":"GET /api/v2/competitor-heatmap","href":"/api-reference/brands/get-v2-competitor-heatmap"},{"title":"Get visibility over time","openapi":"GET /api/v2/visibility-time-series","href":"/api-reference/brands/get-v2-visibility-time-series"},{"title":"Get brand visibility over time","openapi":"GET /api/v2/analytics/brand-visibility-over-time","href":"/api-reference/brands/get-v2-analytics-brand-visibility-over-time"},{"title":"Update a brand","openapi":"PUT /api/v2/brands/{id}","href":"/api-reference/brands/put-v2-brands-id"},{"title":"Read a competitor or own brand","openapi":"GET /api/v2/brands/{id}","href":"/api-reference/brands/get-v2-brands-id"},{"title":"Get a share of voice comparison","openapi":"GET /api/v2/share-of-voice/comparison","href":"/api-reference/brands/get-v2-share-of-voice-comparison"},{"title":"Get share of voice over time","openapi":"GET /api/v2/share-of-voice/time-series","href":"/api-reference/brands/get-v2-share-of-voice-time-series"},{"title":"List brand name and domain aliases","openapi":"GET /api/v2/brands/{id}/aliases","href":"/api-reference/brands/get-v2-brands-id-aliases"},{"title":"Add a brand alias","openapi":"POST /api/v2/brands/{id}/aliases","href":"/api-reference/brands/post-v2-brands-id-aliases"},{"title":"Remove a brand alias","openapi":"DELETE /api/v2/brands/{id}/aliases/{aliasId}","href":"/api-reference/brands/delete-v2-brands-id-aliases-alias-id"},{"title":"Discover competitor identities","openapi":"GET /api/v2/brands/suggestions","href":"/api-reference/brands/get-v2-brands-suggestions"},{"title":"Compare competitor visibility","openapi":"GET /api/v2/brands/metrics","href":"/api-reference/brands/get-v2-brands-metrics"},{"title":"Compare competitor answer positions","openapi":"GET /api/v2/brands/positions","href":"/api-reference/brands/get-v2-brands-positions"},{"title":"Read competitor evidence and analytics","openapi":"GET /api/v2/brands/{id}/analytics","href":"/api-reference/brands/get-v2-brands-id-analytics"},{"title":"Resolve a discovered competitor identity","openapi":"POST /api/v2/brands/decisions","href":"/api-reference/brands/post-v2-brands-decisions"},{"title":"Start or resume a personal competitor review","openapi":"POST /api/v2/brands/reviews","href":"/api-reference/brands/post-v2-brands-reviews"},{"title":"Read your competitor review","openapi":"GET /api/v2/brands/reviews/{sessionId}","href":"/api-reference/brands/get-v2-brands-reviews-session-id"},{"title":"Stage competitor review decisions","openapi":"PATCH /api/v2/brands/reviews/{sessionId}","href":"/api-reference/brands/patch-v2-brands-reviews-session-id"},{"title":"Apply reviewed competitor decisions","openapi":"POST /api/v2/brands/reviews/{sessionId}/apply","href":"/api-reference/brands/post-v2-brands-reviews-session-id-apply"},{"title":"Read the workspace brand","openapi":"GET /api/v2/brands/own-brand","href":"/api-reference/brands/get-v2-brands-own-brand"},{"title":"Configure and confirm the workspace brand","openapi":"PUT /api/v2/brands/own-brand","href":"/api-reference/brands/put-v2-brands-own-brand"},{"title":"Confirm the existing workspace brand","openapi":"POST /api/v2/brands/own-brand/confirm","href":"/api-reference/brands/post-v2-brands-own-brand-confirm"}]},{"group":"Sources and citations","pages":[{"title":"How do I retrieve AI citations and source domains through the API?","sidebarTitle":"Sources and citations","href":"/api-reference/sources-and-citations"},{"title":"Get citation analytics","openapi":"GET /api/v2/citations/analytics","href":"/api-reference/sources-and-citations/get-v2-citations-analytics"},{"title":"Analyse citation positions","openapi":"GET /api/v2/citations/citation-rank-analysis","href":"/api-reference/sources-and-citations/get-v2-citations-citation-rank-analysis"},{"title":"Track domain citations over time","openapi":"GET /api/v2/citations/domain-citations-over-time","href":"/api-reference/sources-and-citations/get-v2-citations-domain-citations-over-time"},{"title":"Compare cited domains by AI platform","openapi":"GET /api/v2/citations/domains-by-llm","href":"/api-reference/sources-and-citations/get-v2-citations-domains-by-llm"},{"title":"Compare sources by AI platform","openapi":"GET /api/v2/citations/llm-sources","href":"/api-reference/sources-and-citations/get-v2-citations-llm-sources"},{"title":"Measure citations to your own domain","openapi":"GET /api/v2/citations/self-citation-frequency","href":"/api-reference/sources-and-citations/get-v2-citations-self-citation-frequency"},{"title":"List the most cited pages","openapi":"GET /api/v2/citations/top-cited-pages","href":"/api-reference/sources-and-citations/get-v2-citations-top-cited-pages"},{"title":"Get source domains","openapi":"GET /api/v2/sources/domains","href":"/api-reference/sources-and-citations/get-v2-sources-domains"},{"title":"Get source overview","openapi":"GET /api/v2/sources/overview","href":"/api-reference/sources-and-citations/get-v2-sources-overview"}]},{"group":"Visitor analytics","pages":[{"title":"How do I retrieve website visitor and crawler analytics through the API?","sidebarTitle":"Visitor analytics","href":"/api-reference/visitor-analytics"},{"title":"Get crawler activity trends","openapi":"GET /api/v2/analytics/crawler-activity-trends","href":"/api-reference/visitor-analytics/get-v2-analytics-crawler-activity-trends"},{"title":"Get referrer statistics","openapi":"GET /api/v2/analytics/referrer-stats","href":"/api-reference/visitor-analytics/get-v2-analytics-referrer-stats"},{"title":"Get sentiment time series","openapi":"GET /api/v2/analytics/sentiment-time-series","href":"/api-reference/visitor-analytics/get-v2-analytics-sentiment-time-series"},{"title":"Get top browsers","openapi":"GET /api/v2/analytics/top-browsers","href":"/api-reference/visitor-analytics/get-v2-analytics-top-browsers"},{"title":"Get top crawler pages","openapi":"GET /api/v2/analytics/top-crawler-pages","href":"/api-reference/visitor-analytics/get-v2-analytics-top-crawler-pages"},{"title":"Get top devices","openapi":"GET /api/v2/analytics/top-devices","href":"/api-reference/visitor-analytics/get-v2-analytics-top-devices"},{"title":"Get top locations","openapi":"GET /api/v2/analytics/top-locations","href":"/api-reference/visitor-analytics/get-v2-analytics-top-locations"},{"title":"Get top pages","openapi":"GET /api/v2/analytics/top-pages","href":"/api-reference/visitor-analytics/get-v2-analytics-top-pages"},{"title":"Get top sources","openapi":"GET /api/v2/analytics/top-sources","href":"/api-reference/visitor-analytics/get-v2-analytics-top-sources"},{"title":"Get total visits","openapi":"GET /api/v2/analytics/total-visits","href":"/api-reference/visitor-analytics/get-v2-analytics-total-visits"},{"title":"Get visitor trends","openapi":"GET /api/v2/analytics/visitor-trends","href":"/api-reference/visitor-analytics/get-v2-analytics-visitor-trends"},{"title":"Read ai referrals overview","openapi":"GET /api/v2/ai-referrals/overview","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-overview"},{"title":"Read ai referrals series","openapi":"GET /api/v2/ai-referrals/series","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-series"},{"title":"Read ai referrals landing pages","openapi":"GET /api/v2/ai-referrals/landing-pages","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-landing-pages"},{"title":"Read ai referrals referrers","openapi":"GET /api/v2/ai-referrals/referrers","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-referrers"},{"title":"Read ai referrals devices","openapi":"GET /api/v2/ai-referrals/devices","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-devices"},{"title":"Read ai referrals events","openapi":"GET /api/v2/ai-referrals/events","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-events"},{"title":"Read ai referrals sessions","openapi":"GET /api/v2/ai-referrals/sessions","href":"/api-reference/visitor-analytics/get-v2-ai-referrals-sessions"},{"title":"Read crawler logs overview","openapi":"GET /api/v2/crawler-logs/overview","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-overview"},{"title":"Read crawler logs chart series","openapi":"GET /api/v2/crawler-logs/chart-series","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-chart-series"},{"title":"Read crawler logs top pages","openapi":"GET /api/v2/crawler-logs/top-pages","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-top-pages"},{"title":"Read crawler logs top crawlers","openapi":"GET /api/v2/crawler-logs/top-crawlers","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-top-crawlers"},{"title":"Read crawler logs events","openapi":"GET /api/v2/crawler-logs/events","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-events"},{"title":"Export crawler events as CSV","openapi":"GET /api/v2/crawler-logs/events/export","href":"/api-reference/visitor-analytics/get-v2-crawler-logs-events-export"}]},{"group":"Content opportunities","pages":[{"title":"How do I retrieve AI content gaps and query fanouts through the API?","sidebarTitle":"Content opportunities","href":"/api-reference/content-opportunities"},{"title":"List query fan-outs","openapi":"GET /api/v2/query-fanouts","href":"/api-reference/content-opportunities/get-v2-query-fanouts"},{"title":"List prompt content gaps","openapi":"GET /api/v2/content-gap/prompts","href":"/api-reference/content-opportunities/get-v2-content-gap-prompts"},{"title":"Get content gap statistics","openapi":"GET /api/v2/content-gap/stats","href":"/api-reference/content-opportunities/get-v2-content-gap-stats"},{"title":"Get the latest content gap analysis","openapi":"GET /api/v2/content-gap/prompts/{promptId}/latest","href":"/api-reference/content-opportunities/get-v2-content-gap-prompts-prompt-id-latest"},{"title":"Read content gap recommendations","openapi":"GET /api/v2/content-gap/prompts/{promptId}/latest/recommendations","href":"/api-reference/content-opportunities/get-v2-content-gap-prompts-prompt-id-latest-recommendations"}]},{"group":"Usage","pages":[{"title":"How do I check AI answer usage through the API?","sidebarTitle":"Usage","href":"/api-reference/usage"},{"title":"Get answer allowance usage","openapi":"GET /api/v2/usage/summary","href":"/api-reference/usage/get-v2-usage-summary"}]},{"group":"Data connections","pages":[{"title":"How do I discover Data API connections and source catalogues?","sidebarTitle":"Data connections","href":"/api-reference/data-connections"},{"title":"List source account tags","openapi":"GET /api/v2/metrics/account-tags","href":"/api-reference/data-connections/get-v2-metrics-account-tags"},{"title":"Create a source account tag","openapi":"POST /api/v2/metrics/account-tags","href":"/api-reference/data-connections/post-v2-metrics-account-tags"},{"title":"List source catalogues","openapi":"GET /api/v2/metrics/catalogues","href":"/api-reference/data-connections/get-v2-metrics-catalogues"},{"title":"List data connections","openapi":"GET /api/v2/metrics/connections","href":"/api-reference/data-connections/get-v2-metrics-connections"},{"title":"List data connectors","openapi":"GET /api/v2/metrics/connectors","href":"/api-reference/data-connections/get-v2-metrics-connectors"},{"title":"List integration clients","openapi":"GET /api/v2/metrics/integration-clients","href":"/api-reference/data-connections/get-v2-metrics-integration-clients"},{"title":"Update a source account tag","openapi":"PUT /api/v2/metrics/account-tags/{accountTagId}","href":"/api-reference/data-connections/put-v2-metrics-account-tags-account-tag-id"},{"title":"Update source account exclusion","openapi":"PUT /api/v2/metrics/source-accounts/{sourceAccountId}/exclusion","href":"/api-reference/data-connections/put-v2-metrics-source-accounts-source-account-id-exclusion"}]},{"group":"Data queries","pages":[{"title":"How do I create and publish queries with the Data API?","sidebarTitle":"Data queries","href":"/api-reference/data-queries"},{"title":"List saved queries","openapi":"GET /api/v2/metrics/queries","href":"/api-reference/data-queries/get-v2-metrics-queries"},{"title":"Create a query","openapi":"POST /api/v2/metrics/queries","href":"/api-reference/data-queries/post-v2-metrics-queries"},{"title":"Read query insights","openapi":"GET /api/v2/metrics/queries/{queryId}/insights","href":"/api-reference/data-queries/get-v2-metrics-queries-query-id-insights"},{"title":"Inspect the query integration contract","openapi":"GET /api/v2/metrics/queries/{queryId}/integration-contract","href":"/api-reference/data-queries/get-v2-metrics-queries-query-id-integration-contract"},{"title":"Execute a query for an integration","openapi":"POST /api/v2/metrics/queries/{queryId}/integration-runs","href":"/api-reference/data-queries/post-v2-metrics-queries-query-id-integration-runs"},{"title":"Create a version of a query","openapi":"POST /api/v2/metrics/queries/{queryId}/versions","href":"/api-reference/data-queries/post-v2-metrics-queries-query-id-versions"},{"title":"Publish a version of a query","openapi":"POST /api/v2/metrics/queries/{queryId}/versions/{versionId}/publish","href":"/api-reference/data-queries/post-v2-metrics-queries-query-id-versions-version-id-publish"}]},{"group":"Data operations","pages":[{"title":"How do I execute Data API operations and retrieve results?","sidebarTitle":"Data operations","href":"/api-reference/data-operations"},{"title":"Read saved data with MCP","openapi":"POST /api/v2/metrics/mcp","href":"/api-reference/data-operations/post-v2-metrics-mcp"},{"title":"List operations","openapi":"GET /api/v2/metrics/operations","href":"/api-reference/data-operations/get-v2-metrics-operations"},{"title":"Create an operation","openapi":"POST /api/v2/metrics/operations","href":"/api-reference/data-operations/post-v2-metrics-operations"},{"title":"Create definitions in a batch","openapi":"POST /api/v2/metrics/commands/batch-create","href":"/api-reference/data-operations/post-v2-metrics-commands-batch-create"},{"title":"Clone a reusable definition","openapi":"POST /api/v2/metrics/commands/clone","href":"/api-reference/data-operations/post-v2-metrics-commands-clone"},{"title":"Validate a definition command","openapi":"POST /api/v2/metrics/commands/validate","href":"/api-reference/data-operations/post-v2-metrics-commands-validate"},{"title":"Get an operation","openapi":"GET /api/v2/metrics/operations/{operationId}","href":"/api-reference/data-operations/get-v2-metrics-operations-operation-id"},{"title":"Create an operation","openapi":"POST /api/v2/metrics/imports/{importedDatasetId}/operations","href":"/api-reference/data-operations/post-v2-metrics-imports-imported-dataset-id-operations"},{"title":"Cancel an operation","openapi":"POST /api/v2/metrics/operations/{operationId}/cancel","href":"/api-reference/data-operations/post-v2-metrics-operations-operation-id-cancel"},{"title":"Read operation results","openapi":"GET /api/v2/metrics/operations/{operationId}/results","href":"/api-reference/data-operations/get-v2-metrics-operations-operation-id-results"}]},{"group":"Data delivery","pages":[{"title":"How do I manage data imports, schedules and destinations through the API?","sidebarTitle":"Data delivery","href":"/api-reference/data-delivery"},{"title":"List delivery destinations","openapi":"GET /api/v2/metrics/destinations","href":"/api-reference/data-delivery/get-v2-metrics-destinations"},{"title":"Create a delivery destination","openapi":"POST /api/v2/metrics/destinations","href":"/api-reference/data-delivery/post-v2-metrics-destinations"},{"title":"Create an email import intake","openapi":"POST /api/v2/metrics/import-email-intakes","href":"/api-reference/data-delivery/post-v2-metrics-import-email-intakes"},{"title":"Create an import source","openapi":"POST /api/v2/metrics/import-sources","href":"/api-reference/data-delivery/post-v2-metrics-import-sources"},{"title":"List imported datasets","openapi":"GET /api/v2/metrics/imports","href":"/api-reference/data-delivery/get-v2-metrics-imports"},{"title":"Create an imported dataset","openapi":"POST /api/v2/metrics/imports","href":"/api-reference/data-delivery/post-v2-metrics-imports"},{"title":"List refresh schedules","openapi":"GET /api/v2/metrics/schedules","href":"/api-reference/data-delivery/get-v2-metrics-schedules"},{"title":"Create a refresh schedule","openapi":"POST /api/v2/metrics/schedules","href":"/api-reference/data-delivery/post-v2-metrics-schedules"},{"title":"List data transfers","openapi":"GET /api/v2/metrics/transfers","href":"/api-reference/data-delivery/get-v2-metrics-transfers"},{"title":"Create a data transfer","openapi":"POST /api/v2/metrics/transfers","href":"/api-reference/data-delivery/post-v2-metrics-transfers"},{"title":"Create a version of a delivery destination","openapi":"POST /api/v2/metrics/destinations/{destinationId}/versions","href":"/api-reference/data-delivery/post-v2-metrics-destinations-destination-id-versions"},{"title":"Register an email import attachment","openapi":"POST /api/v2/metrics/import-email-intakes/{intakeId}/attachments","href":"/api-reference/data-delivery/post-v2-metrics-import-email-intakes-intake-id-attachments"},{"title":"Finalise an import source","openapi":"POST /api/v2/metrics/import-sources/{sourceObjectId}/finalize","href":"/api-reference/data-delivery/post-v2-metrics-import-sources-source-object-id-finalize"},{"title":"Profile an import source","openapi":"POST /api/v2/metrics/import-sources/{sourceObjectId}/profile","href":"/api-reference/data-delivery/post-v2-metrics-import-sources-source-object-id-profile"},{"title":"Create an import upload session","openapi":"POST /api/v2/metrics/import-sources/{sourceObjectId}/upload-session","href":"/api-reference/data-delivery/post-v2-metrics-import-sources-source-object-id-upload-session"},{"title":"Request dataset deletion","openapi":"POST /api/v2/metrics/imports/{importedDatasetId}/deletion","href":"/api-reference/data-delivery/post-v2-metrics-imports-imported-dataset-id-deletion"},{"title":"Cancel dataset deletion","openapi":"DELETE /api/v2/metrics/imports/{importedDatasetId}/deletion","href":"/api-reference/data-delivery/delete-v2-metrics-imports-imported-dataset-id-deletion"},{"title":"Update the status of a refresh schedule","openapi":"PUT /api/v2/metrics/schedules/{scheduleId}/status","href":"/api-reference/data-delivery/put-v2-metrics-schedules-schedule-id-status"},{"title":"Create a version of a refresh schedule","openapi":"POST /api/v2/metrics/schedules/{scheduleId}/versions","href":"/api-reference/data-delivery/post-v2-metrics-schedules-schedule-id-versions"},{"title":"Update the status of a data transfer","openapi":"PUT /api/v2/metrics/transfers/{transferId}/status","href":"/api-reference/data-delivery/put-v2-metrics-transfers-transfer-id-status"},{"title":"Create a version of a data transfer","openapi":"POST /api/v2/metrics/transfers/{transferId}/versions","href":"/api-reference/data-delivery/post-v2-metrics-transfers-transfer-id-versions"},{"title":"Publish a version of a delivery destination","openapi":"POST /api/v2/metrics/destinations/{destinationId}/versions/{versionId}/publish","href":"/api-reference/data-delivery/post-v2-metrics-destinations-destination-id-versions-version-id-publish"},{"title":"Publish a version of a refresh schedule","openapi":"POST /api/v2/metrics/schedules/{scheduleId}/versions/{versionId}/publish","href":"/api-reference/data-delivery/post-v2-metrics-schedules-schedule-id-versions-version-id-publish"},{"title":"Publish a version of a data transfer","openapi":"POST /api/v2/metrics/transfers/{transferId}/versions/{versionId}/publish","href":"/api-reference/data-delivery/post-v2-metrics-transfers-transfer-id-versions-version-id-publish"}]},{"group":"Data definitions","pages":[{"title":"How do I create and version reusable data definitions through the API?","sidebarTitle":"Data definitions","href":"/api-reference/data-definitions"},{"title":"List analysis views","openapi":"GET /api/v2/metrics/analysis-views","href":"/api-reference/data-definitions/get-v2-metrics-analysis-views"},{"title":"Create an analysis view","openapi":"POST /api/v2/metrics/analysis-views","href":"/api-reference/data-definitions/post-v2-metrics-analysis-views"},{"title":"List query templates","openapi":"GET /api/v2/metrics/templates","href":"/api-reference/data-definitions/get-v2-metrics-templates"},{"title":"Get usage","openapi":"GET /api/v2/metrics/usage","href":"/api-reference/data-definitions/get-v2-metrics-usage"},{"title":"List reusable definitions","openapi":"GET /api/v2/metrics/definitions/{resourceType}","href":"/api-reference/data-definitions/get-v2-metrics-definitions-resource-type"},{"title":"Create a reusable definition","openapi":"POST /api/v2/metrics/definitions/{resourceType}","href":"/api-reference/data-definitions/post-v2-metrics-definitions-resource-type"},{"title":"Create a version of a reusable definition","openapi":"POST /api/v2/metrics/definitions/{resourceType}/{resourceId}/versions","href":"/api-reference/data-definitions/post-v2-metrics-definitions-resource-type-resource-id-versions"},{"title":"Publish a version of a reusable definition","openapi":"POST /api/v2/metrics/definitions/{resourceType}/{resourceId}/versions/{versionId}/publish","href":"/api-reference/data-definitions/post-v2-metrics-definitions-resource-type-resource-id-versions-version-id-publish"}]},{"group":"Data webhooks","pages":[{"title":"How do I manage signed Data API webhooks?","sidebarTitle":"Data webhooks","href":"/api-reference/data-webhooks"},{"title":"List webhook endpoints","openapi":"GET /api/v2/metrics/webhooks","href":"/api-reference/data-webhooks/get-v2-metrics-webhooks"},{"title":"Create a webhook endpoint","openapi":"POST /api/v2/metrics/webhooks","href":"/api-reference/data-webhooks/post-v2-metrics-webhooks"},{"title":"Update a webhook endpoint","openapi":"PATCH /api/v2/metrics/webhooks/{endpointId}","href":"/api-reference/data-webhooks/patch-v2-metrics-webhooks-endpoint-id"},{"title":"Delete a webhook endpoint","openapi":"DELETE /api/v2/metrics/webhooks/{endpointId}","href":"/api-reference/data-webhooks/delete-v2-metrics-webhooks-endpoint-id"},{"title":"List webhook deliveries","openapi":"GET /api/v2/metrics/webhooks/{endpointId}/deliveries","href":"/api-reference/data-webhooks/get-v2-metrics-webhooks-endpoint-id-deliveries"},{"title":"Rotate the webhook signing secret","openapi":"POST /api/v2/metrics/webhooks/{endpointId}/rotate","href":"/api-reference/data-webhooks/post-v2-metrics-webhooks-endpoint-id-rotate"},{"title":"Replay a webhook delivery","openapi":"POST /api/v2/metrics/webhooks/{endpointId}/deliveries/{deliveryId}/replay","href":"/api-reference/data-webhooks/post-v2-metrics-webhooks-endpoint-id-deliveries-delivery-id-replay"}]},{"group":"Client authorisation","pages":[{"title":"How do spreadsheet clients request user authorisation?","sidebarTitle":"Client authorisation","href":"/api-reference/client-authorisation"},{"title":"Create an authorisation challenge","openapi":"POST /api/v2/metrics/client-auth/challenges","href":"/api-reference/client-authorisation/post-v2-metrics-client-auth-challenges"},{"title":"Exchange an approved authorisation challenge","openapi":"POST /api/v2/metrics/client-auth/challenges/{challengeId}/exchange","href":"/api-reference/client-authorisation/post-v2-metrics-client-auth-challenges-challenge-id-exchange"}]},{"group":"Spreadsheet clients","pages":[{"title":"How do I read and write data with an authorised spreadsheet client?","sidebarTitle":"Spreadsheet clients","href":"/api-reference/spreadsheet-clients"},{"title":"List spreadsheet bindings","openapi":"GET /api/v2/metrics/client/bindings","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-bindings"},{"title":"Create a spreadsheet binding","description":"Access document-bound client sessions, queries, schedules, bindings and write claims.","openapi":"POST /api/v2/metrics/client/bindings","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-bindings"},{"title":"List source catalogues","openapi":"GET /api/v2/metrics/client/catalogues","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-catalogues"},{"title":"List data connections","description":"Access document-bound client sessions, queries, schedules, bindings and write claims.","openapi":"GET /api/v2/metrics/client/connections","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-connections"},{"title":"List data connectors","openapi":"GET /api/v2/metrics/client/connectors","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-connectors"},{"title":"List workspace members","openapi":"GET /api/v2/metrics/client/members","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-members"},{"title":"List operations","openapi":"GET /api/v2/metrics/client/operations","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-operations"},{"title":"Create an operation","openapi":"POST /api/v2/metrics/client/operations","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-operations"},{"title":"List saved queries","openapi":"GET /api/v2/metrics/client/queries","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-queries"},{"title":"Create a query","openapi":"POST /api/v2/metrics/client/queries","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-queries"},{"title":"List refresh schedules","openapi":"GET /api/v2/metrics/client/schedules","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-schedules"},{"title":"Create a refresh schedule","openapi":"POST /api/v2/metrics/client/schedules","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-schedules"},{"title":"Inspect the spreadsheet session","openapi":"GET /api/v2/metrics/client/session","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-session"},{"title":"Revoke the spreadsheet session","openapi":"DELETE /api/v2/metrics/client/session","href":"/api-reference/spreadsheet-clients/delete-v2-metrics-client-session"},{"title":"List query templates","openapi":"GET /api/v2/metrics/client/templates","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-templates"},{"title":"Create a spreadsheet write claim","openapi":"POST /api/v2/metrics/client/writes","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-writes"},{"title":"Delete a spreadsheet binding","openapi":"DELETE /api/v2/metrics/client/bindings/{bindingId}","href":"/api-reference/spreadsheet-clients/delete-v2-metrics-client-bindings-binding-id"},{"title":"Get an operation","openapi":"GET /api/v2/metrics/client/operations/{operationId}","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-operations-operation-id"},{"title":"Delete a spreadsheet write claim","openapi":"DELETE /api/v2/metrics/client/writes/{writeClaimId}","href":"/api-reference/spreadsheet-clients/delete-v2-metrics-client-writes-write-claim-id"},{"title":"Transfer spreadsheet resource ownership","openapi":"POST /api/v2/metrics/client/bindings/{bindingId}/ownership","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-bindings-binding-id-ownership"},{"title":"Create a version of a spreadsheet binding","openapi":"POST /api/v2/metrics/client/bindings/{bindingId}/versions","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-bindings-binding-id-versions"},{"title":"Cancel an operation","openapi":"POST /api/v2/metrics/client/operations/{operationId}/cancel","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-operations-operation-id-cancel"},{"title":"Read operation results","openapi":"GET /api/v2/metrics/client/operations/{operationId}/results","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-operations-operation-id-results"},{"title":"Read query insights","openapi":"GET /api/v2/metrics/client/queries/{queryId}/insights","href":"/api-reference/spreadsheet-clients/get-v2-metrics-client-queries-query-id-insights"},{"title":"Create a version of a query","openapi":"POST /api/v2/metrics/client/queries/{queryId}/versions","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-queries-query-id-versions"},{"title":"Transfer spreadsheet resource ownership","openapi":"POST /api/v2/metrics/client/schedules/{scheduleId}/ownership","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-schedules-schedule-id-ownership"},{"title":"Update the status of a refresh schedule","openapi":"PUT /api/v2/metrics/client/schedules/{scheduleId}/status","href":"/api-reference/spreadsheet-clients/put-v2-metrics-client-schedules-schedule-id-status"},{"title":"Create a version of a refresh schedule","openapi":"POST /api/v2/metrics/client/schedules/{scheduleId}/versions","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-schedules-schedule-id-versions"},{"title":"Record a spreadsheet write checkpoint","openapi":"POST /api/v2/metrics/client/writes/{writeClaimId}/checkpoints","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-writes-write-claim-id-checkpoints"},{"title":"Commit a spreadsheet write","openapi":"POST /api/v2/metrics/client/writes/{writeClaimId}/commit","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-writes-write-claim-id-commit"},{"title":"Publish a version of a spreadsheet binding","openapi":"POST /api/v2/metrics/client/bindings/{bindingId}/versions/{versionId}/publish","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-bindings-binding-id-versions-version-id-publish"},{"title":"Publish a version of a query","openapi":"POST /api/v2/metrics/client/queries/{queryId}/versions/{versionId}/publish","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-queries-query-id-versions-version-id-publish"},{"title":"Publish a version of a refresh schedule","openapi":"POST /api/v2/metrics/client/schedules/{scheduleId}/versions/{versionId}/publish","href":"/api-reference/spreadsheet-clients/post-v2-metrics-client-schedules-schedule-id-versions-version-id-publish"}]},{"group":"AI visibility audits","pages":[{"title":"How do I create website AI visibility audits through the API?","sidebarTitle":"AI visibility audits","href":"/api-reference/ai-visibility-audits"},{"title":"Create an AI visibility audit","openapi":"POST /api/v1/audits","href":"/api-reference/ai-visibility-audits/post-v1-audits"},{"title":"Get an AI visibility audit","openapi":"GET /api/v1/audits/{id}","href":"/api-reference/ai-visibility-audits/get-v1-audits-id"}]},{"group":"Version 1","pages":[{"title":"Which version 1 AI visibility API endpoints are available?","sidebarTitle":"Version 1","href":"/api-reference/version-1"},{"title":"Get brand visibility","openapi":"GET /api/v1/brand-visibility","href":"/api-reference/version-1/get-v1-brand-visibility"},{"title":"List collected answers","openapi":"GET /api/v1/prompt-runs","href":"/api-reference/version-1/get-v1-prompt-runs"},{"title":"List monitoring prompts","openapi":"GET /api/v1/prompts","href":"/api-reference/version-1/get-v1-prompts"},{"title":"Get visitor metrics","openapi":"GET /api/v1/analytics/visitor-metrics","href":"/api-reference/version-1/get-v1-analytics-visitor-metrics"},{"title":"Get AI crawler events","openapi":"GET /api/v1/crawler-logs/events","href":"/api-reference/version-1/get-v1-crawler-logs-events"},{"title":"Get crawler log integrations","openapi":"GET /api/v1/crawler-logs/integrations","href":"/api-reference/version-1/get-v1-crawler-logs-integrations"},{"title":"Get workspace metrics","openapi":"GET /api/v1/metrics/summary","href":"/api-reference/version-1/get-v1-metrics-summary"},{"title":"Get a collected answer","openapi":"GET /api/v1/prompt-runs/{id}","href":"/api-reference/version-1/get-v1-prompt-runs-id"},{"title":"Get source domains","openapi":"GET /api/v1/sources/domains","href":"/api-reference/version-1/get-v1-sources-domains"},{"title":"Get source overview","openapi":"GET /api/v1/sources/overview","href":"/api-reference/version-1/get-v1-sources-overview"},{"title":"Get monthly answer usage","openapi":"GET /api/v1/usage/monthly","href":"/api-reference/version-1/get-v1-usage-monthly"}]},{"group":"Tracked coverage","pages":[{"title":"How do I manage published coverage and citation evidence through the API?","sidebarTitle":"Tracked coverage","href":"/api-reference/tracked-coverage"},{"title":"List tracked coverage","openapi":"GET /api/v2/coverage","href":"/api-reference/tracked-coverage/get-v2-coverage"},{"title":"Add tracked coverage","openapi":"POST /api/v2/coverage","href":"/api-reference/tracked-coverage/post-v2-coverage"},{"title":"Get tracked coverage and evidence","openapi":"GET /api/v2/coverage/{coverageId}","href":"/api-reference/tracked-coverage/get-v2-coverage-detail"},{"title":"Update, archive or restore tracked coverage","openapi":"PATCH /api/v2/coverage/{coverageId}","href":"/api-reference/tracked-coverage/patch-v2-coverage"},{"title":"Measure tracked coverage citation evidence","openapi":"GET /api/v2/coverage/measurement","href":"/api-reference/tracked-coverage/get-v2-coverage-measurement"},{"title":"Find existing coverage by published URL","openapi":"POST /api/v2/coverage/lookup","href":"/api-reference/tracked-coverage/post-v2-coverage-lookup"}]},{"group":"Reports","pages":[{"title":"How do I compose and assess native reports through the API?","sidebarTitle":"Reports","href":"/api-reference/reports"},{"title":"Create a private native empty report draft","openapi":"POST /api/v2/reports","href":"/api-reference/reports/create-native-report-draft"},{"title":"Find accessible reports","openapi":"GET /api/v2/reports","href":"/api-reference/reports/get-canvas-reports"},{"title":"Read the exact report identity and assessment pages","openapi":"GET /api/v2/reports/{reportId}","href":"/api-reference/reports/get-canvas-report"},{"title":"Discover native assessment targets, contexts and profiles","openapi":"GET /api/v2/reports/canvas/capabilities","href":"/api-reference/reports/get-canvas-capabilities"},{"title":"Assess an exact saved report revision","openapi":"POST /api/v2/reports/{reportId}/assessments","href":"/api-reference/reports/post-canvas-assessment"},{"title":"Read assessment or composition progress","openapi":"GET /api/v2/reports/canvas/jobs/{jobId}","href":"/api-reference/reports/get-canvas-job"},{"title":"Cancel assessment or composition work","openapi":"POST /api/v2/reports/canvas/jobs/{jobId}/cancel","href":"/api-reference/reports/cancel-canvas-job"},{"title":"Read assessment readiness and pageable findings","openapi":"GET /api/v2/reports/canvas/assessments/{assessmentId}","href":"/api-reference/reports/get-canvas-assessment"},{"title":"Discover granular native configuration contracts","openapi":"GET /api/v2/reports/capabilities","href":"/api-reference/reports/get-report-capability-index"},{"title":"Read one versioned native configuration schema","openapi":"GET /api/v2/reports/capabilities/{schemaId}","href":"/api-reference/reports/get-report-capability-schema"},{"title":"Begin exact private native authoring","openapi":"POST /api/v2/reports/{reportId}/change-sets","href":"/api-reference/reports/create-report-change-set"},{"title":"Read confirmed private authoring receipts","openapi":"GET /api/v2/reports/{reportId}/change-sets/{changeSetId}","href":"/api-reference/reports/read-report-change-set"},{"title":"Discard uncommitted private authoring","openapi":"DELETE /api/v2/reports/{reportId}/change-sets/{changeSetId}","href":"/api-reference/reports/discard-report-change-set"},{"title":"Append typed native changes","openapi":"POST /api/v2/reports/{reportId}/change-sets/{changeSetId}/batches","href":"/api-reference/reports/append-report-changes"},{"title":"Validate and freeze the native stage","openapi":"POST /api/v2/reports/{reportId}/change-sets/{changeSetId}/seal","href":"/api-reference/reports/seal-report-change-set"},{"title":"Compose a sealed native change set","openapi":"POST /api/v2/reports/canvas/compositions","href":"/api-reference/reports/post-canvas-composition"},{"title":"Read measured plan and bounded placements/findings","openapi":"GET /api/v2/reports/canvas/plans/{planId}","href":"/api-reference/reports/get-canvas-plan"},{"title":"Install the exact measured native candidate atomically","openapi":"POST /api/v2/reports/canvas/plans/{planId}/commit","href":"/api-reference/reports/commit-canvas-plan"},{"title":"Read workspace branding, fonts and authoring guide","openapi":"GET /api/v2/reports/authoring-context","href":"/api-reference/reports/get-report-authoring-context"},{"title":"Compare private document and existing shared artifact identities","openapi":"GET /api/v2/reports/{reportId}/publication-state","href":"/api-reference/reports/get-report-publication-state"},{"title":"Read complete native page elements and optional surface provenance","openapi":"GET /api/v2/reports/{reportId}/pages/{pageId}","href":"/api-reference/reports/get-native-report-page"},{"title":"Read independently authorized source contracts without executing Data","openapi":"GET /api/v2/reports/{reportId}/data-sources","href":"/api-reference/reports/get-native-report-data-sources"},{"title":"Attach a Data query to a report","openapi":"POST /api/v2/reports/{reportId}/data-sources","href":"/api-reference/reports/attach-report-query"},{"title":"Upload a report image","openapi":"POST /api/v2/reports/images","href":"/api-reference/reports/upload-report-image"},{"title":"Create a native report share","openapi":"POST /api/v2/reports/{reportId}/shares","href":"/api-reference/reports/create-report-share"},{"title":"Revoke a native report share","openapi":"POST /api/v2/reports/{reportId}/shares/{shareId}/revoke","href":"/api-reference/reports/revoke-report-share"},{"title":"Adopt cached query output for a report","openapi":"POST /api/v2/reports/{reportId}/data-sources/{sourceId}/adopt","href":"/api-reference/reports/adopt-report-query-output"},{"title":"Save native report edits using a revision","openapi":"POST /api/v2/reports/{reportId}/save","href":"/api-reference/reports/save-native-report"},{"title":"List built-in report datasets","openapi":"GET /api/v2/reports/native-datasets","href":"/api-reference/reports/list-native-report-datasets"},{"title":"Attach and snapshot native report evidence","openapi":"POST /api/v2/reports/{reportId}/native-data-sources","href":"/api-reference/reports/attach-native-report-dataset"}]},{"group":"SEO","pages":[{"title":"How do I use authorized SEO tools with MCP?","sidebarTitle":"SEO","href":"/api-reference/seo"},{"title":"Call authorized SEO tools with MCP","openapi":"POST /api/seo/mcp","href":"/api-reference/seo/post-seo-mcp"},{"title":"Reject unsupported SEO MCP GET","openapi":"GET /api/seo/mcp","href":"/api-reference/seo/get-seo-mcp-unsupported"},{"title":"Reject unsupported SEO MCP DELETE","openapi":"DELETE /api/seo/mcp","href":"/api-reference/seo/delete-seo-mcp-unsupported"}]}]}]}]},"title":"List source catalogues - chatobserver","buildId":"dpl_97FnoaXsHWBPVnhAXKbsJhyZPDAZ","deploymentId":"dpl_97FnoaXsHWBPVnhAXKbsJhyZPDAZ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DYAwUFUq.js","utils-LI5rXc3r.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-GfppTbPm.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BPFLM8Mq.js","snippetPresets-Btc4xQeU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-LC5xpRFB.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CWFNX7Et.js","shallow-BHmlySwj.js","getApiPlaygroundDisplay-KMA-x8Y0.js","CodeSnippet-Du8lcnbV.js","CodeSnippets-BnivWBV8.js","Page-CfQRK9Qm.js","getPastedJson-L9Ydjksu.js","icon-RENl5Vc0.js","MethodPill-BayqM3da.js","DuplicateIcon-DUYKDB5b.js","createIcon-Cq6sFly2.js","DynamicMarkdown-9f3PaiTz.js","SectionHeading-C-tunuWF.js","axios-vUo_bRtp.js","Markdown-DPg72QEK.js","clsx-CnxmmBfL.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-0Q6cLfBv.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Crds1y05.js"]}