{
"error": {
"code": "service_unavailable",
"message": "The reporting service is temporarily unavailable. Try again in a few minutes."
}
}
Reports
Get a report
The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access.
Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time.
Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period.
Period. Send from and to together, both included. Without them the dashboard’s default period applies, and the response does not say which dates it covered (period.from and period.to are null).
Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a nulldata_through, not an error.
Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results.
Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods.
Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
Comma-separated metric keys from list reports. Leave it out for the report's default_metrics. Asking for more than a call allows answers 422, and error.details gives the maximum.
Break every metric into one row per period, replacing the tile's own grain; single-number metrics then come as a series without value. One of the report's group_by values.
Comma-separated Claudia project names to restrict to. Leave it out for every project you can access. A project you cannot access answers 422, and error.details lists the ones you can.
Newest conversation matching the filters, regardless of the period, in local time without offset (Brasília for most accounts). null when nothing matches or when this lookup did not finish in time. Not a refresh time: an account without recent conversations shows an old date even when its data is current.
Present only when something limited the answer. no_claudia_projects: you can access no Claudia project on this account, so no metric was computed. partial_results: some metrics did not finish in time and have timed_out set to true.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cloud Chat","colors":{"primary":"#EF7221","light":"#FF9D5C","dark":"#D65E10"},"logo":{"light":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626","dark":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/dark.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=95d8350f3dade95801b6c310d5ba597f"},"favicon":"https://mintcdn.com/cloud-humans/T7XxBi09ex74abIC/favicon.svg?fit=max\u0026auto=format\u0026n=T7XxBi09ex74abIC\u0026q=85\u0026s=6b1379d1ea0f266d6ca12eb1f8ccbf77","fonts":{"family":"Inter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloud-humans","hasAudioNarration":false,"actualSubdomain":"cloud-humans","customDomains":["docs.cloudhumans.com"],"gitSource":{"type":"github","owner":"cloudhumans","repo":"dev-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af48b87af084288ba3478bc","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":164},{"language":"default","tag":"Cloud Chat","count":108},{"language":"default","tag":"Claudia","count":61},{"language":"default","tag":"Guides","count":32},{"language":"default","tag":"Data Export","count":27},{"language":"default","tag":"Table Catalog","count":19},{"language":"default","tag":"Agents","count":18},{"language":"default","tag":"Help Center","count":15},{"language":"default","tag":"Controlled Flows","count":14},{"language":"default","tag":"Conversations","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/cloudchat/endpoints/get-a-report","slug":"/api-reference/cloudchat/endpoints/get-a-report","pageMetadata":{"title":"Get a report","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports/{reportKey}","description":"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access.\n\n- **Freshness.** Data is not real time, and `data_through` is the newest matching conversation, not a refresh time.\n- **Shape.** Each metric returns `rows` as its tile computes them, keyed by the column labels it shows, plus `value` when the result is a single number. Some tiles are a series even without `group_by` (CSAT by week, transfer reasons by day); their first bucket can be dated before `from` but holds only days inside the period.\n- **Period.** Send `from` and `to` together, both included. Without them the dashboard's default period applies, and the response does not say which dates it covered (`period.from` and `period.to` are `null`).\n- **Filters.** Filter values must match the data exactly: one that matches nothing returns zeros and a `null` `data_through`, not an error.\n- **Partial answers.** A heavy call can return some metrics with `timed_out` set to `true` and `warnings` including `partial_results`.\n- **Comparing periods.** There is no previous-period value. Prefer one call over the whole span with `group_by` set to `week` or `month`; call twice only for irregular periods.\n\nValues the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported `group_by`, projects you cannot access) answer `422`, and `error.details` says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers `400`.","href":"/api-reference/cloudchat/endpoints/get-a-report"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Freshness.\"\n }), \" Data is not real time, and \", _jsx(_components.code, {\n children: \"data_through\"\n }), \" is the newest matching conversation, not a refresh time.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Shape.\"\n }), \" Each metric returns \", _jsx(_components.code, {\n children: \"rows\"\n }), \" as its tile computes them, keyed by the column labels it shows, plus \", _jsx(_components.code, {\n children: \"value\"\n }), \" when the result is a single number. Some tiles are a series even without \", _jsx(_components.code, {\n children: \"group_by\"\n }), \" (CSAT by week, transfer reasons by day); their first bucket can be dated before \", _jsx(_components.code, {\n children: \"from\"\n }), \" but holds only days inside the period.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Period.\"\n }), \" Send \", _jsx(_components.code, {\n children: \"from\"\n }), \" and \", _jsx(_components.code, {\n children: \"to\"\n }), \" together, both included. Without them the dashboard’s default period applies, and the response does not say which dates it covered (\", _jsx(_components.code, {\n children: \"period.from\"\n }), \" and \", _jsx(_components.code, {\n children: \"period.to\"\n }), \" are \", _jsx(_components.code, {\n children: \"null\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Filters.\"\n }), \" Filter values must match the data exactly: one that matches nothing returns zeros and a \", _jsx(_components.code, {\n children: \"null\"\n }), \" \", _jsx(_components.code, {\n children: \"data_through\"\n }), \", not an error.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Partial answers.\"\n }), \" A heavy call can return some metrics with \", _jsx(_components.code, {\n children: \"timed_out\"\n }), \" set to \", _jsx(_components.code, {\n children: \"true\"\n }), \" and \", _jsx(_components.code, {\n children: \"warnings\"\n }), \" including \", _jsx(_components.code, {\n children: \"partial_results\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Comparing periods.\"\n }), \" There is no previous-period value. Prefer one call over the whole span with \", _jsx(_components.code, {\n children: \"group_by\"\n }), \" set to \", _jsx(_components.code, {\n children: \"week\"\n }), \" or \", _jsx(_components.code, {\n children: \"month\"\n }), \"; call twice only for irregular periods.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported \", _jsx(_components.code, {\n children: \"group_by\"\n }), \", projects you cannot access) answer \", _jsx(_components.code, {\n children: \"422\"\n }), \", and \", _jsx(_components.code, {\n children: \"error.details\"\n }), \" says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers \", _jsx(_components.code, {\n children: \"400\"\n }), \".\"]\n })]\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];const CloudChatYourValues=()=>{const _components={a:`a`,..._provideComponents()};const STORAGE_KEY=`cloudchat-api-selected-account`;const CREDENTIALS_HREF=`/api-reference/cloudchat/credentials`;const[saved,setSaved]=useState(null);const[ready,setReady]=useState(false);useEffect(()=>{let value=null;try{const raw=window.localStorage.getItem(STORAGE_KEY);if(raw){const parsed=JSON.parse(raw);if(parsed\u0026\u0026parsed.instance\u0026\u0026parsed.account){value={instance:String(parsed.instance),account:String(parsed.account),name:typeof parsed.name===`string`\u0026\u0026parsed.name?parsed.name:null}}}}catch(error){value=null}setSaved(value);setReady(true)},[]);const shell=`not-prose rounded-xl border border-gray-200 dark:border-white/10 bg-gray-50 dark:bg-white/5 px-4 py-3 mb-6`;if(!ready||!saved){return _jsx(`div`,{className:`not-prose mint-rounded-xl mint-border mint-border-gray-200 dark:mint-border-white/10 mint-bg-gray-50 dark:mint-bg-white/5 mint-px-4 mint-py-3 mint-mb-6`,children:_jsxs(`p`,{className:`mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[`Every request below needs your `,_jsx(`code`,{children:`cloudchat-instance`}),` header and your account id.`,` `,_jsx(_components.a,{href:CREDENTIALS_HREF,className:`mint-underline mint-underline-offset-2`,children:`Paste your token`}),` `,`and they will show up here, ready to copy.`]})})}return _jsx(`div`,{className:`not-prose mint-rounded-xl mint-border mint-border-gray-200 dark:mint-border-white/10 mint-bg-gray-50 dark:mint-bg-white/5 mint-px-4 mint-py-3 mint-mb-6`,children:_jsxs(`div`,{className:`mint-flex mint-flex-wrap mint-items-baseline mint-gap-x-6 mint-gap-y-2`,children:[_jsxs(`div`,{children:[_jsx(`span`,{className:`mint-text-xs mint-uppercase mint-tracking-wide mint-text-gray-500 dark:mint-text-gray-400`,children:`cloudchat-instance`}),_jsx(`span`,{className:`mint-ml-2 mint-font-mono mint-text-sm mint-text-gray-900 dark:mint-text-gray-100`,children:saved.instance})]}),_jsxs(`div`,{children:[_jsx(`span`,{className:`mint-text-xs mint-uppercase mint-tracking-wide mint-text-gray-500 dark:mint-text-gray-400`,children:`accountId`}),_jsx(`span`,{className:`mint-ml-2 mint-font-mono mint-text-sm mint-text-gray-900 dark:mint-text-gray-100`,children:saved.account})]}),saved.name\u0026\u0026_jsx(`span`,{className:`mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:saved.name}),_jsx(_components.a,{href:CREDENTIALS_HREF,className:`mint-text-sm mint-text-gray-500 dark:mint-text-gray-400 mint-underline mint-underline-offset-2`,children:`Change`})]})})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`CloudChatYourValues`,children:_jsx(CloudChatYourValues,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{CloudChatYourValues,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a report","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports/{reportKey}","description":"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access.\n\n- **Freshness.** Data is not real time, and `data_through` is the newest matching conversation, not a refresh time.\n- **Shape.** Each metric returns `rows` as its tile computes them, keyed by the column labels it shows, plus `value` when the result is a single number. Some tiles are a series even without `group_by` (CSAT by week, transfer reasons by day); their first bucket can be dated before `from` but holds only days inside the period.\n- **Period.** Send `from` and `to` together, both included. Without them the dashboard's default period applies, and the response does not say which dates it covered (`period.from` and `period.to` are `null`).\n- **Filters.** Filter values must match the data exactly: one that matches nothing returns zeros and a `null` `data_through`, not an error.\n- **Partial answers.** A heavy call can return some metrics with `timed_out` set to `true` and `warnings` including `partial_results`.\n- **Comparing periods.** There is no previous-period value. Prefer one call over the whole span with `group_by` set to `week` or `month`; call twice only for irregular periods.\n\nValues the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported `group_by`, projects you cannot access) answer `422`, and `error.details` says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers `400`.","href":"/api-reference/cloudchat/endpoints/get-a-report"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[139,2658,"null;function _creat"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mb-6 {\n margin-bottom: 1.5rem\n}\n.mint-ml-2 {\n margin-left: 0.5rem\n}\n.mint-flex {\n display: flex\n}\n.mint-flex-wrap {\n flex-wrap: wrap\n}\n.mint-items-baseline {\n align-items: baseline\n}\n.mint-gap-x-6 {\n column-gap: 1.5rem\n}\n.mint-gap-y-2 {\n row-gap: 0.5rem\n}\n.mint-rounded-xl {\n border-radius: 0.75rem\n}\n.mint-border {\n border-width: 1px\n}\n.mint-border-gray-200 {\n --tw-border-opacity: 1;\n border-color: rgb(229 231 235 / var(--tw-border-opacity, 1))\n}\n.mint-bg-gray-50 {\n --tw-bg-opacity: 1;\n background-color: rgb(249 250 251 / var(--tw-bg-opacity, 1))\n}\n.mint-px-4 {\n padding-left: 1rem;\n padding-right: 1rem\n}\n.mint-py-3 {\n padding-top: 0.75rem;\n padding-bottom: 0.75rem\n}\n.mint-font-mono {\n font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace\n}\n.mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-text-xs {\n font-size: 0.75rem;\n line-height: 1rem\n}\n.mint-uppercase {\n text-transform: uppercase\n}\n.mint-tracking-wide {\n letter-spacing: 0.025em\n}\n.mint-text-gray-500 {\n --tw-text-opacity: 1;\n color: rgb(107 114 128 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-600 {\n --tw-text-opacity: 1;\n color: rgb(75 85 99 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-900 {\n --tw-text-opacity: 1;\n color: rgb(17 24 39 / var(--tw-text-opacity, 1))\n}\n.mint-underline {\n text-decoration-line: underline\n}\n.mint-underline-offset-2 {\n text-underline-offset: 2px\n}\n.dark\\:mint-border-white\\/10:is(.dark *) {\n border-color: rgb(255 255 255 / 0.1)\n}\n.dark\\:mint-bg-white\\/5:is(.dark *) {\n background-color: rgb(255 255 255 / 0.05)\n}\n.dark\\:mint-text-gray-100:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(243 244 246 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(156 163 175 / var(--tw-text-opacity, 1))\n}","openApiReferenceData":{"operation":{"operationId":"getReport","summary":"Get a report","description":"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access.\n\n- **Freshness.** Data is not real time, and `data_through` is the newest matching conversation, not a refresh time.\n- **Shape.** Each metric returns `rows` as its tile computes them, keyed by the column labels it shows, plus `value` when the result is a single number. Some tiles are a series even without `group_by` (CSAT by week, transfer reasons by day); their first bucket can be dated before `from` but holds only days inside the period.\n- **Period.** Send `from` and `to` together, both included. Without them the dashboard's default period applies, and the response does not say which dates it covered (`period.from` and `period.to` are `null`).\n- **Filters.** Filter values must match the data exactly: one that matches nothing returns zeros and a `null` `data_through`, not an error.\n- **Partial answers.** A heavy call can return some metrics with `timed_out` set to `true` and `warnings` including `partial_results`.\n- **Comparing periods.** There is no previous-period value. Prefer one call over the whole span with `group_by` set to `week` or `month`; call twice only for irregular periods.\n\nValues the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported `group_by`, projects you cannot access) answer `422`, and `error.details` says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers `400`.","tags":["Reports"],"parameters":["5d47a5e0-2b17-4009-8a42-abfe34c00747","7cf97fc8-2290-475c-82d2-02023b940947","5a246a49-711a-4413-8fe4-1102dc7a5f74","78f035c6-5f56-4b46-86d9-0f8b585300a7","d4a6391e-ee1d-4140-b2aa-0d6cd621a6c2","010c00bd-e3af-4719-ab37-35459655bd47","8bc9fd9f-bac1-414d-ad8e-21d93ae73223","c51dbae7-1f11-4f86-9e56-337fb05b45de","bb4e490b-1703-426b-9af1-71e7a3999105"],"responses":{"200":"7f7453b1-de31-4f72-8c39-24f04aad5aac","400":"bd1b1606-b200-4da0-91f4-fd64e2334283","401":"b62c6ad3-5342-4f98-85c2-fd0411501426","403":"7af1b20d-3148-4386-8439-adf9c62608ca","404":"35c4457d-482a-4185-b26c-4a1469bf3416","422":"d4730fed-6b2c-45af-b01f-e8041da5a832","429":"73a77633-ea74-409a-baed-fe6ed9d1b29a","500":"b04e65f4-0d2a-4492-9898-72187691e79b","503":"2312951c-e5ee-44ba-aa94-95fb86e48f3b"},"method":"get","type":"path","servers":["d1112c91-ee32-4c8d-905e-2c190370d38f"],"security":["6b4f58e0-00dd-4326-9335-79d9d80168f3"],"path":"/v1/accounts/{accountId}/reports/{reportKey}","baseUrlOptions":["https://api.cloudhumans.com/cloudchat"],"title":"Get a report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5d47a5e0-2b17-4009-8a42-abfe34c00747":{"name":"metrics","in":"query","required":false,"description":"Comma-separated metric keys from [list reports](/api-reference/cloudchat/endpoints/list-reports). Leave it out for the report's `default_metrics`. Asking for more than a call allows answers `422`, and `error.details` gives the maximum.","schema":{"type":"string","example":"retention,volume","isRequired":false,"description":"Comma-separated metric keys from [list reports](/api-reference/cloudchat/endpoints/list-reports). Leave it out for the report's `default_metrics`. Asking for more than a call allows answers `422`, and `error.details` gives the maximum.","uniqueKey":"","typeLabel":"string"}},"7cf97fc8-2290-475c-82d2-02023b940947":{"name":"from","in":"query","required":false,"description":"First day of the period, `YYYY-MM-DD`, included. Send it together with `to`.","schema":{"type":"string","example":"2026-09-21","isRequired":false,"description":"First day of the period, `YYYY-MM-DD`, included. Send it together with `to`.","uniqueKey":"","typeLabel":"string"}},"5a246a49-711a-4413-8fe4-1102dc7a5f74":{"name":"to","in":"query","required":false,"description":"Last day of the period, `YYYY-MM-DD`, included. Send it together with `from`.","schema":{"type":"string","example":"2026-10-11","isRequired":false,"description":"Last day of the period, `YYYY-MM-DD`, included. Send it together with `from`.","uniqueKey":"","typeLabel":"string"}},"78f035c6-5f56-4b46-86d9-0f8b585300a7":{"name":"group_by","in":"query","required":false,"description":"Break every metric into one row per period, replacing the tile's own grain; single-number metrics then come as a series without `value`. One of the report's `group_by` values.","schema":{"type":"string","example":"week","isRequired":false,"description":"Break every metric into one row per period, replacing the tile's own grain; single-number metrics then come as a series without `value`. One of the report's `group_by` values.","uniqueKey":"","typeLabel":"string"}},"d4a6391e-ee1d-4140-b2aa-0d6cd621a6c2":{"name":"project","in":"query","required":false,"description":"Comma-separated Claudia project names to restrict to. Leave it out for every project you can access. A project you cannot access answers `422`, and `error.details` lists the ones you can.","schema":{"type":"string","example":"\u003cPROJECT_NAME>","isRequired":false,"description":"Comma-separated Claudia project names to restrict to. Leave it out for every project you can access. A project you cannot access answers `422`, and `error.details` lists the ones you can.","uniqueKey":"","typeLabel":"string"}},"010c00bd-e3af-4719-ab37-35459655bd47":{"name":"closing","in":"query","required":false,"description":"Comma-separated values of the dashboard's **Fechamento** filter, in Portuguese exactly as stored: `Dentro do horário` or `Fora do horário`.","schema":{"type":"string","example":"Dentro do horário","isRequired":false,"description":"Comma-separated values of the dashboard's **Fechamento** filter, in Portuguese exactly as stored: `Dentro do horário` or `Fora do horário`.","uniqueKey":"","typeLabel":"string"}},"8bc9fd9f-bac1-414d-ad8e-21d93ae73223":{"name":"resolution_reason","in":"query","required":false,"description":"Comma-separated resolution reasons, exactly as stored. This API does not list them.","schema":{"type":"string","example":"\u003cREASON>","isRequired":false,"description":"Comma-separated resolution reasons, exactly as stored. This API does not list them.","uniqueKey":"","typeLabel":"string"}},"c51dbae7-1f11-4f86-9e56-337fb05b45de":{"name":"tag","in":"query","required":false,"description":"Comma-separated conversation tags, exactly as stored. This API does not list them.","schema":{"type":"string","example":"\u003cTAG>","isRequired":false,"description":"Comma-separated conversation tags, exactly as stored. This API does not list them.","uniqueKey":"","typeLabel":"string"}},"bb4e490b-1703-426b-9af1-71e7a3999105":{"name":"ab_test","in":"query","required":false,"description":"Comma-separated A/B test keys, exactly as stored.","schema":{"type":"string","example":"\u003cAB_TEST_KEY>","isRequired":false,"description":"Comma-separated A/B test keys, exactly as stored.","uniqueKey":"","typeLabel":"string"}},"a2642bc3-13bf-43b1-a76d-6cab58f902b0":{"name":"cloudchat-instance","in":"header","required":true,"description":"Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. [The API overview](/api-reference/cloudchat/overview#two-headers-every-call) explains how instances work, how to find yours, and the errors a wrong or missing value produces.","schema":{"type":"integer","example":1,"isRequired":true,"description":"Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. [The API overview](/api-reference/cloudchat/overview#two-headers-every-call) explains how instances work, how to find yours, and the errors a wrong or missing value produces.","uniqueKey":"","typeLabel":"integer"}},"a0340d55-8542-40e4-85f3-286a4403a205":{"name":"accountId","in":"path","required":true,"description":"Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the `cloudchat-instance` header — the two travel together. Account numbers are only unique **within** an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.","schema":{"type":"integer","example":1,"isRequired":true,"description":"Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the `cloudchat-instance` header — the two travel together. Account numbers are only unique **within** an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.","uniqueKey":"","typeLabel":"integer"}},"6244cf2a-ad16-41fb-b464-9ec1d9200584":{"name":"reportKey","in":"path","required":true,"description":"The report to read, as `key` in [list reports](/api-reference/cloudchat/endpoints/list-reports).","schema":{"type":"string","example":"claudia_general_info","isRequired":true,"description":"The report to read, as `key` in [list reports](/api-reference/cloudchat/endpoints/list-reports).","uniqueKey":"","typeLabel":"string"}}},"responses":{"7f7453b1-de31-4f72-8c39-24f04aad5aac":{"description":"The numbers of the report.","content":{"application/json":{"schema":{"type":"object","description":"The numbers of one report.","required":["report","period","filters","metrics","data_through_approximate"],"properties":{"report":{"type":"object","description":"Which report answered.","required":["key","name"],"properties":{"key":{"type":"string","description":"The report key.","isRequired":true,"uniqueKey":"report.key","typeLabel":"string"},"name":{"type":"string","description":"The report name, as Cloud Chat shows it.","isRequired":true,"uniqueKey":"report.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"report","typeLabel":"object"},"period":{"type":"object","description":"The period the numbers cover.","required":["dashboard_default","axis"],"properties":{"dashboard_default":{"type":"boolean","description":"`true` when you sent no `from`/`to` and the dashboard default period applied.","isRequired":true,"uniqueKey":"period.dashboard_default","typeLabel":"boolean"},"axis":{"type":"string","description":"Which date the period filters on, as `date_axis` in the report list.","isRequired":true,"uniqueKey":"period.axis","typeLabel":"string"},"from":{"oneOf":[{"type":"string","description":"First day, `YYYY-MM-DD`. `null` when the dashboard default period applied.","uniqueKey":"period.from.oneOf.0","typeLabel":"string"},{"type":"null","description":"First day, `YYYY-MM-DD`. `null` when the dashboard default period applied.","uniqueKey":"period.from.oneOf.1","typeLabel":"null"}],"uniqueKey":"period.from","typeLabel":"string | null"},"to":{"oneOf":[{"type":"string","description":"Last day, `YYYY-MM-DD`, included. `null` when the dashboard default period applied.","uniqueKey":"period.to.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last day, `YYYY-MM-DD`, included. `null` when the dashboard default period applied.","uniqueKey":"period.to.oneOf.1","typeLabel":"null"}],"uniqueKey":"period.to","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"period","typeLabel":"object"},"filters":{"type":"object","description":"The filters applied, by parameter, each with the values you sent. Empty when you sent none.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"filters.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filters.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"filters","typeLabel":"object"},"metrics":{"type":"array","description":"The metrics you asked for, in the report order.","items":{"type":"object","description":"One metric of the report.","required":["key","rows","truncated","timed_out"],"properties":{"key":{"type":"string","description":"The metric key.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].key","typeLabel":"string"},"rows":{"type":"array","description":"The rows as the tile computes them, keyed by column key (see `columns` for labels). Dates come as `YYYY-MM-DD`, numbers as numbers and an empty cell as `null`: no data, not zero. Prefer `value` when present. Empty when `timed_out` is `true`.","items":{"type":"object","additionalProperties":true,"uniqueKey":"metrics.items.[INDEX].rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"metrics.items.[INDEX].rows","typeLabel":"object[]"},"truncated":{"type":"boolean","description":"`true` when `rows` hit the row cap, so more rows may exist. Narrow the period or the filters to get them all.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].truncated","typeLabel":"boolean"},"timed_out":{"type":"boolean","description":"`true` when this metric did not finish in time; `rows` is then empty. Retry the same call or only these metrics: finished ones come back quickly.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].timed_out","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"The metric name as the dashboard shows it, in the dashboard's language.","uniqueKey":"metrics.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The metric name as the dashboard shows it, in the dashboard's language.","uniqueKey":"metrics.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"metrics.items.[INDEX].name","typeLabel":"string | null"},"columns":{"type":"array","description":"The columns of `rows`, in order: the key each row uses and the label the dashboard shows for it.","items":{"type":"object","required":["key","label"],"properties":{"key":{"type":"string","description":"The key of this column in each row.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].columns.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","description":"The column label as the dashboard shows it.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].columns.items.[INDEX].label","typeLabel":"string"}},"uniqueKey":"metrics.items.[INDEX].columns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"metrics.items.[INDEX].columns","typeLabel":"object[]"},"value":{"type":"number","description":"Present only when the result is a single number, such as a rate or a total. Absent with `group_by`.","uniqueKey":"metrics.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"metrics.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"metrics","typeLabel":"object[]"},"data_through_approximate":{"type":"boolean","description":"Always `true`; see `data_through`.","isRequired":true,"uniqueKey":"data_through_approximate","typeLabel":"boolean"},"group_by":{"oneOf":[{"type":"string","description":"The period the series were split by, or `null` for the dashboard default.","uniqueKey":"group_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"The period the series were split by, or `null` for the dashboard default.","uniqueKey":"group_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"group_by","typeLabel":"string | null"},"data_through":{"oneOf":[{"type":"string","description":"Newest conversation matching the filters, regardless of the period, in local time without offset (Brasília for most accounts). `null` when nothing matches or when this lookup did not finish in time. Not a refresh time: an account without recent conversations shows an old date even when its data is current.","uniqueKey":"data_through.oneOf.0","typeLabel":"string"},{"type":"null","description":"Newest conversation matching the filters, regardless of the period, in local time without offset (Brasília for most accounts). `null` when nothing matches or when this lookup did not finish in time. Not a refresh time: an account without recent conversations shows an old date even when its data is current.","uniqueKey":"data_through.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_through","typeLabel":"string | null"},"warnings":{"type":"array","description":"Present only when something limited the answer. `no_claudia_projects`: you can access no Claudia project on this account, so no metric was computed. `partial_results`: some metrics did not finish in time and have `timed_out` set to `true`.","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"uniqueKey":"warnings","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"report":{"key":"claudia_general_info","name":"ClaudIA - Informações Gerais"},"period":{"from":"2026-09-21","to":"2026-10-11","dashboard_default":false,"axis":"conversation_created"},"filters":{},"group_by":"week","metrics":[{"key":"retention","name":"Taxa de retenção","truncated":false,"timed_out":false,"columns":[{"key":"creation_date[week]","label":"Creation Date Week"},{"key":"taxa_retencao_pct","label":"Taxa de retencao (%)"}],"rows":[{"creation_date[week]":"2026-09-21","taxa_retencao_pct":57.2},{"creation_date[week]":"2026-09-28","taxa_retencao_pct":54.21},{"creation_date[week]":"2026-10-05","taxa_retencao_pct":59.47}]}],"data_through":"2026-10-14 19:39:58.556","data_through_approximate":true},"examples":{"Example":{"title":"Example","value":{"report":{"key":"claudia_general_info","name":"ClaudIA - Informações Gerais"},"period":{"from":"2026-09-21","to":"2026-10-11","dashboard_default":false,"axis":"conversation_created"},"filters":{},"group_by":"week","metrics":[{"key":"retention","name":"Taxa de retenção","truncated":false,"timed_out":false,"columns":[{"key":"creation_date[week]","label":"Creation Date Week"},{"key":"taxa_retencao_pct","label":"Taxa de retencao (%)"}],"rows":[{"creation_date[week]":"2026-09-21","taxa_retencao_pct":57.2},{"creation_date[week]":"2026-09-28","taxa_retencao_pct":54.21},{"creation_date[week]":"2026-10-05","taxa_retencao_pct":59.47}]}],"data_through":"2026-10-14 19:39:58.556","data_through_approximate":true}}},"exampleType":"examples"}},"exampleType":"examples"},"bd1b1606-b200-4da0-91f4-fd64e2334283":{"description":"The request itself is malformed, before any value is validated:\n\n- a body that isn't valid JSON, or one with no `canned_response` wrapper,\n- a `canned_response` that isn't an object (`{\"canned_response\": \"text\"}`),\n- `page`, `per_page`, `search` or `sort` sent as an array or a nested object (`?page[]=1`, `?sort[x]=y`) instead of a plain value,\n- **the `cloudchat-instance` header missing or holding a value we don't route,**\n- an `accountId` that is not a number — including the literal `{accountId}` that some API clients send when the argument is left unset. This one answers with the normal envelope and `error.details` naming `accountId`, and it is deliberately **not** a 404: a 404 would mean the account cannot be reached, while this means the value was never an account id at all, so re-read the argument instead of trying other numbers.\n\n**Two different shapes answer with 400, and the difference will bite you on day one.** That last case is rejected before the request reaches the API, so `error` is a plain **string** instead of the usual object:\n\n```json\n{ \"error\": \"\u003chuman-readable message>\" }\n```\n\nEvery other 400 uses the normal envelope, where `error` is an object with `code` and `message`. Reading `error.code` without checking the type first throws on the missing-header case — which is the most likely 400 of your first integration. Check `typeof error === \"string\"` first, or read `error?.code` defensively.\n\nA 400 always means fix the request shape; it never means a value was rejected. Rejected values are 422.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"bad_request","message":"The request is malformed."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"The request is malformed."}}}},"exampleType":"examples"}},"exampleType":"examples"},"b62c6ad3-5342-4f98-85c2-fd0411501426":{"description":"No Bearer token, or one that is expired, malformed, or not a Cognito token. Sign in again for a fresh `id_token`.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Authentication is required. Send a valid Bearer token in the Authorization header."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Authentication is required. Send a valid Bearer token in the Authorization header."}}}},"exampleType":"examples"}},"exampleType":"examples"},"7af1b20d-3148-4386-8439-adf9c62608ca":{"description":"Reading reports needs an administrator, supervisor or CX engineer role, or an agent role on an account that granted reports to its agents. A suspended account also answers `403`, and then nothing on it works until it is reactivated.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"You are not allowed to perform this action."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"You are not allowed to perform this action."}}}},"exampleType":"examples"}},"exampleType":"examples"},"35c4457d-482a-4185-b26c-4a1469bf3416":{"description":"The account does not exist, you are not a member of it, reports are not enabled on it, or the `reportKey` does not exist. These cases are deliberately indistinguishable. Check `reportKey` against [list reports](/api-reference/cloudchat/endpoints/list-reports) before anything else.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Resource could not be found."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource could not be found."}}}},"exampleType":"examples"}},"exampleType":"examples"},"d4730fed-6b2c-45af-b01f-e8041da5a832":{"description":"A value the report cannot accept. `error.details` names each one and what it accepts.","content":{"application/json":{"schema":{"type":"object","description":"A `validation_failed` error, which carries `details`.","required":["error"],"properties":{"error":{"type":"object","required":["code","message","details"],"properties":{"code":{"type":"string","enum":["validation_failed"],"example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Localized to the account's language, like every other envelope message.","example":"The request payload is invalid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"One entry per rejected field. Unlike the envelope message above, the texts come from the model layer and are in English in practice (the model layer ships no translations) — match on code and field, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about — `short_code` or `content`. A rule that is not tied to either is reported as `base`, so treat `base` as \"the payload as a whole\" rather than a field you can highlight.","enum":["short_code","content","base"],"example":"short_code","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Which rule it broke — `blank` for a missing or empty value, `taken` for a `short_code` already used on the account.","example":"taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","example":"has already been taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"The request payload is invalid.","details":[{"field":"metrics","code":"inclusion","message":"Unknown metrics: \u003cKEY>. Available: volume, n1_retained, retention, csat_n1"}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"The request payload is invalid.","details":[{"field":"metrics","code":"inclusion","message":"Unknown metrics: \u003cKEY>. Available: volume, n1_retained, retention, csat_n1"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"73a77633-ea74-409a-baed-fe6ed9d1b29a":{"description":"Rate limited. The gateway answers `{ \"message\": ... }`, with `Retry-After` and the `ratelimit-*` headers carrying the current values. Other limits answer the usual envelope with code `rate_limited` and can apply even when your account made few calls: wait a minute before retrying. Don't hardcode any limit.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Rejected by the gateway before Cloud Chat saw it, so it does not use the `error` envelope.","required":["message"],"properties":{"message":{"type":"string","example":"API rate limit exceeded","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"request_id":{"type":"string","description":"Gateway request id. Quote it when reporting a problem.","example":"f3f7567638d4b65a8003057d0c77d275","uniqueKey":"oneOf.0.request_id","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"oneOf.1.error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Too many requests. Wait a minute and try again."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Too many requests. Wait a minute and try again."}}}},"exampleType":"examples"}},"exampleType":"examples"},"b04e65f4-0d2a-4492-9898-72187691e79b":{"description":"Something broke on our side. It is reported to our monitoring automatically. Retrying the same call will not help until it is fixed.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"internal_error","message":"An unexpected error occurred. Please try again later."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"An unexpected error occurred. Please try again later."}}}},"exampleType":"examples"}},"exampleType":"examples"},"2312951c-e5ee-44ba-aa94-95fb86e48f3b":{"description":"The reporting backend is unavailable, or no metric finished in time. Retry in a few minutes; if it persists, ask for fewer metrics or a shorter period.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"service_unavailable","message":"The reporting service is temporarily unavailable. Try again in a few minutes."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"service_unavailable","message":"The reporting service is temporarily unavailable. Try again in a few minutes."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6b4f58e0-00dd-4326-9335-79d9d80168f3":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d1112c91-ee32-4c8d-905e-2c190370d38f":{"url":"https://api.cloudhumans.com/cloudchat","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/specs/cloudchat/v1.json"},"subdomain":"cloud-humans","siteName":"Cloud Chat","title":"Get a report - Cloud Chat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T20:18:21.375Z","originalFileLocation":"api-reference/cloudchat/endpoints/get-a-report.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access. - Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time. - Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period. - Period. Send from and to together, both included. Without them the dashboard\u0026#x27;s default period applies, and the response does not say which dates it covered (period.from and period.to are null). - Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a null data_through, not an error. - Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results. - Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods. Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a report - Cloud Chat\">\u003cmeta data-mint-head property=\"og:description\" content=\"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access. - Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time. - Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period. - Period. Send from and to together, both included. Without them the dashboard\u0026#x27;s default period applies, and the response does not say which dates it covered (period.from and period.to are null). - Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a null data_through, not an error. - Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results. - Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods. Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cloud Chat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+a+report\u0026amp;description=The+numbers+of+one+report+for+a+period+and+a+set+of+filters%2C+the+same+its+dashboard+shows+in+Cloud+Chat%2C+restricted+to+the+Claudia+projects+you+can+access.%0A%0A-+*\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=23a570089673f7701b7afcb92ffd031b7af194435f7b09d778f1ab6c23fea395\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a report - Cloud Chat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access. - Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time. - Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period. - Period. Send from and to together, both included. Without them the dashboard\u0026#x27;s default period applies, and the response does not say which dates it covered (period.from and period.to are null). - Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a null data_through, not an error. - Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results. - Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods. Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+a+report\u0026amp;description=The+numbers+of+one+report+for+a+period+and+a+set+of+filters%2C+the+same+its+dashboard+shows+in+Cloud+Chat%2C+restricted+to+the+Claudia+projects+you+can+access.%0A%0A-+*\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=23a570089673f7701b7afcb92ffd031b7af194435f7b09d778f1ab6c23fea395\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF7221\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cloudchat/endpoints/get-a-report.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cloudhumans.com/#organization\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cloudhumans.com#website\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report#webpage\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report\",\"name\":\"Get a report\",\"description\":\"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access. - Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time. - Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period. - Period. Send from and to together, both included. Without them the dashboard's default period applies, and the response does not say which dates it covered (period.from and period.to are null). - Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a null data_through, not an error. - Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results. - Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods. Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.\",\"dateModified\":\"2026-10-20T20:18:21.375Z\",\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reports\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/list-reports\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a report\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report#apireference\",\"headline\":\"Get a report\",\"name\":\"Get a report\",\"description\":\"The numbers of one report for a period and a set of filters, the same its dashboard shows in Cloud Chat, restricted to the Claudia projects you can access. - Freshness. Data is not real time, and data_through is the newest matching conversation, not a refresh time. - Shape. Each metric returns rows as its tile computes them, keyed by the column labels it shows, plus value when the result is a single number. Some tiles are a series even without group_by (CSAT by week, transfer reasons by day); their first bucket can be dated before from but holds only days inside the period. - Period. Send from and to together, both included. Without them the dashboard's default period applies, and the response does not say which dates it covered (period.from and period.to are null). - Filters. Filter values must match the data exactly: one that matches nothing returns zeros and a null data_through, not an error. - Partial answers. A heavy call can return some metrics with timed_out set to true and warnings including partial_results. - Comparing periods. There is no previous-period value. Prefer one call over the whole span with group_by set to week or month; call twice only for irregular periods. Values the report cannot accept (unknown metrics or filters, a malformed, one-sided, reversed or too long period, an unsupported group_by, projects you cannot access) answer 422, and error.details says what is accepted. Query parameters this endpoint does not define are ignored, so check their spelling; any parameter sent as an array or an object answers 400.\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/get-a-report#webpage\"},\"dateModified\":\"2026-10-20T20:18:21.375Z\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cloud Chat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cloud Chat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cloudchat/endpoints/get-a-report.md","siteName":"Cloud Chat","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","products":[{"product":"Cloud Chat","icon":"messages","groups":[{"group":"Getting Started","pages":[{"title":"Cloud Chat API","href":"/api-reference/cloudchat/overview"},{"title":"Find your credentials","href":"/api-reference/cloudchat/credentials"}]},{"group":"Authentication","pages":[{"title":"Sign in and get a token","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin","href":"/api-reference/cloudchat/v1/auth/authentication/sign-in-and-get-a-token"},{"title":"Answer a sign-in challenge","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin/challenge","href":"/api-reference/cloudchat/v1/auth/authentication/answer-a-sign-in-challenge"}]},{"group":"Canned Responses","pages":[{"title":"List canned responses","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/list-canned-responses"},{"title":"Get a canned response","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/get-a-canned-response"},{"title":"Create a canned response","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/create-a-canned-response"},{"title":"Update a canned response","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/update-a-canned-response"},{"title":"Delete a canned response","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/delete-a-canned-response"}]},{"group":"Conversations","pages":[{"title":"List conversations","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/list-conversations"},{"title":"Find a conversation by any identifier","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/find","href":"/api-reference/cloudchat/endpoints/find-a-conversation"},{"title":"Get a conversation","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/get-a-conversation"},{"title":"List conversation messages","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}/messages","href":"/api-reference/cloudchat/endpoints/list-conversation-messages"},{"title":"Open a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/open-a-conversation"},{"title":"Update a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/update-a-conversation"},{"title":"Change the status of a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}/status","href":"/api-reference/cloudchat/endpoints/change-conversation-status"},{"title":"Assign a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/assignments","href":"/api-reference/cloudchat/endpoints/assign-a-conversation"},{"title":"Add an internal note to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/notes","href":"/api-reference/cloudchat/endpoints/add-a-conversation-note"},{"title":"Block the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/mute","href":"/api-reference/cloudchat/endpoints/block-the-contact-of-a-conversation"},{"title":"Unblock the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/unmute","href":"/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation"}]},{"group":"Contacts","pages":[{"title":"List contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/list-contacts"},{"title":"Search contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/search","href":"/api-reference/cloudchat/endpoints/search-contacts"},{"title":"Get a contact","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/get-a-contact"},{"title":"Create a contact","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/create-a-contact"},{"title":"Update a contact","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/update-a-contact"}]},{"group":"Labels","pages":[{"title":"List labels","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/labels","href":"/api-reference/cloudchat/endpoints/list-labels"}]},{"group":"Inboxes","pages":[{"title":"List inboxes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes","href":"/api-reference/cloudchat/endpoints/list-inboxes"},{"title":"Get an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/get-an-inbox"},{"title":"Update an inbox's settings","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/update-an-inbox"},{"title":"List inbox members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/list-inbox-members"},{"title":"Add inbox members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/add-inbox-members"},{"title":"Remove inbox members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/remove-inbox-members"},{"title":"Get the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/get-the-satisfaction-survey-of-an-inbox"},{"title":"Update the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/update-the-satisfaction-survey-of-an-inbox"}]},{"group":"Campaigns","pages":[{"title":"Preview campaign recipients","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns/preview-recipients","href":"/api-reference/cloudchat/endpoints/preview-campaign-recipients"},{"title":"Create a campaign","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns","href":"/api-reference/cloudchat/endpoints/create-a-campaign"},{"title":"Get a campaign","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/{campaignId}","href":"/api-reference/cloudchat/endpoints/get-a-campaign"},{"title":"List campaign variables","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/variables","href":"/api-reference/cloudchat/endpoints/list-campaign-variables"},{"title":"List message templates","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/list-message-templates"},{"title":"Create a message template","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/create-a-message-template"},{"title":"Update a message template","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates/{name}","href":"/api-reference/cloudchat/endpoints/update-a-message-template"}]},{"group":"Reports","pages":[{"title":"List reports","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports","description":"The reports you can read with [get a report](/api-reference/cloudchat/endpoints/get-a-report). Each one is a dashboard from the Reports area of Cloud Chat, and reading it through the API returns the same numbers the dashboard shows.\n\nFor each report the list gives the metric keys you can ask for, the metrics returned when you ask for none, the filters it accepts and how its time series can be grouped. These differ per report, so read them from here instead of hardcoding them.","href":"/api-reference/cloudchat/endpoints/list-reports"},{"title":"Get a report","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports/{reportKey}","href":"/api-reference/cloudchat/endpoints/get-a-report"},{"title":"List report query fields","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/report-queries/fields","description":"The fields you can ask for with [run a report query](/api-reference/cloudchat/endpoints/run-a-report-query), for questions about ClaudIA conversations that no metric of [get a report](/api-reference/cloudchat/endpoints/get-a-report) answers. When a report has the metric, prefer it: its numbers are the ones the Cloud Chat dashboards show.\n\nA `dimension` splits the rows and a `measure` is aggregated within each split. Each date also comes split by period, such as `creation_date[week]` or `creation_date[month]`, to group rows by week or month. Only `STRING` dimensions can be filtered.","href":"/api-reference/cloudchat/endpoints/list-report-query-fields"},{"title":"Run a report query","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/report-queries","href":"/api-reference/cloudchat/endpoints/run-a-report-query"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/list-agents"},{"title":"Get an agent","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/get-an-agent"},{"title":"Create an agent","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/create-an-agent"},{"title":"Update an agent","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/update-an-agent"},{"title":"Get agent access","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/get-agent-access"},{"title":"Set agent access","openapi":"api-reference/specs/cloudchat/v1.json PUT /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/set-agent-access"}]},{"group":"Teams","pages":[{"title":"List teams","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/list-teams"},{"title":"Get a team","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/get-a-team"},{"title":"Create a team","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/create-a-team"},{"title":"Update a team","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/update-a-team"},{"title":"List team members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/list-team-members"},{"title":"Add team members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/add-team-members"},{"title":"Remove team members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/remove-team-members"}]},{"group":"Macros","pages":[{"title":"List macros","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/list-macros"},{"title":"Get a macro","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/get-a-macro"},{"title":"Create a macro","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/create-a-macro"},{"title":"Update a macro","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/update-a-macro"}]},{"group":"Custom Views","pages":[{"title":"List custom views","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/list-custom-views"},{"title":"Get a custom view","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-view"},{"title":"Create a custom view","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/create-a-custom-view"},{"title":"Update a custom view","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-view"},{"title":"Delete a custom view","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/delete-a-custom-view"}]},{"group":"Automation Rules","pages":[{"title":"List automation rules","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules","href":"/api-reference/cloudchat/endpoints/list-automation-rules"},{"title":"Get an automation rule","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules/{automationRuleId}","href":"/api-reference/cloudchat/endpoints/get-an-automation-rule"}]},{"group":"Availability Reasons","pages":[{"title":"List availability reasons","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/list-availability-reasons"},{"title":"Create an availability reason","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/create-an-availability-reason"},{"title":"Update an availability reason","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/update-an-availability-reason"},{"title":"Delete an availability reason","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/delete-an-availability-reason"}]},{"group":"Native Attribute Requirements","pages":[{"title":"List native attribute requirements","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/list-native-attribute-requirements"},{"title":"Require a native attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/create-a-native-attribute-requirement"},{"title":"Stop requiring a native attribute","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/native-attribute-requirements/{nativeAttributeRequirementId}","href":"/api-reference/cloudchat/endpoints/delete-a-native-attribute-requirement"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attributes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/list-custom-attributes"},{"title":"Get a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-attribute"},{"title":"Create a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/create-a-custom-attribute"},{"title":"Update a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-attribute"}]},{"group":"Help Center","pages":[{"title":"List portals","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/list-portals"},{"title":"Get a portal","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/get-a-portal"},{"title":"Create a portal","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/create-a-portal"},{"title":"Update a portal","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/update-a-portal"},{"title":"List categories","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/list-categories"},{"title":"Get a category","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/get-a-category"},{"title":"Create a category","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/create-a-category"},{"title":"Update a category","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/update-a-category"},{"title":"Delete a category","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/delete-a-category"},{"title":"List articles","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/list-articles"},{"title":"Get an article","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/get-an-article"},{"title":"Create an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/create-an-article"},{"title":"Update an article","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/update-an-article"},{"title":"Translate an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}/translate","href":"/api-reference/cloudchat/endpoints/translate-an-article"},{"title":"Delete an article","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/delete-an-article"}]},{"group":"Uploads","pages":[{"title":"Upload an image","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/uploads","href":"/api-reference/cloudchat/endpoints/upload-an-image"}]}]},{"product":"Claudia","icon":"robot","pages":[{"title":"Claudia","href":"/api-reference/claudia/sign-in"}]},{"product":"Controlled Flows","icon":"diagram-project","pages":[{"title":"Controlled Flows","href":"/api-reference/controlled-flows/overview"}]}]}]},"basePath":"","title":"Get a report - Cloud Chat","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}