{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
Analytics
Get metrics breakdown
Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams.
Metrics and the dimensions they support (metric and groupBy)
credits: user, group, agent, workflow, source
chatMessages: user, group, agent, source
workflowRuns: user, group, workflow
meetingHours: user, group
meetings: user, group
For meetingHours and meetings, each meeting counts toward the member it’s attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings.
Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.
The range is widened to whole days in UTC.
Requires the Analytics permission (analytics:read).
Only count usage by this user. For meetingHours and meetings, only count meetings billed to them, which are the meetings they were first to add the notetaker to.
Only include these Agents, using the IDs from the agent breakdown or /chats. Built-in models combine their thinking levels. Pass several as a comma-separated list.
Only include Agents that use these models, such as claude-opus-5-5, including the built-in model's own Agent. Agents count as the model they use today, so changing an Agent's model moves its past usage too. Thinking levels are combined. Pass several as a comma-separated list.
Only count Agent chat usage from this source, such as slack or web. Available for credits and chatMessages; with credits, only Agent chat credits count.
Users, groups, Agents, Workflows, or sources with usage in the range, largest first. At most 10000 rows. Groups use current group membership, and a user in several groups counts toward each, so group values can overlap. Agent and source values count direct chats only, not usage inside Workflows, and built-in model Agents combine their thinking levels. For meetingHours and meetings, each meeting counts toward the member it's attributed to, the person who first added the notetaker.
True when more than 10000 rows had usage and only the largest were returned. Narrow the range or add a filter to see the rest.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cassidy","colors":{"primary":"#325ED1","light":"#547ADE","dark":"#2852BF"},"logo":{"light":"https://mintcdn.com/cassidy/wE0GgFgF7sg6yClA/logo/light.svg?fit=max\u0026auto=format\u0026n=wE0GgFgF7sg6yClA\u0026q=85\u0026s=a282ef0ea39b2568b4c0d9164c38a471","dark":"https://mintcdn.com/cassidy/wE0GgFgF7sg6yClA/logo/dark.svg?fit=max\u0026auto=format\u0026n=wE0GgFgF7sg6yClA\u0026q=85\u0026s=97b6c3e038ba04fb75c98291dce0f15e"},"favicon":"https://mintcdn.com/cassidy/OMxepbwbagSrdWXh/favicon.png?fit=max\u0026auto=format\u0026n=OMxepbwbagSrdWXh\u0026q=85\u0026s=e2b5f49115e3bdfcbf30f5793e849793","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:support@cassidyai.com","label":"Support"}],"primary":{"type":"button","label":"Get started","href":"https://app.cassidy.ai"}},"footer":{"socials":{"x":"https://x.com/Cassidy_AI","linkedin":"https://www.linkedin.com/company/cassidyai"}},"fonts":{"family":"Inter"},"integrations":{"intercom":{"appId":"n12guz9i"}},"contextual":{"options":["copy","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cassidy","hasAudioNarration":false,"actualSubdomain":"cassidy","customDomains":["docs.cassidyai.com"],"gitSource":{"type":"github","owner":"cassidyai","repo":"cassidy","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeccc0a3c2f00fc09de9461","collectionId":"e3b19f4f-714b-495d-9f6d-628b95dba971","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeccc0a3c2f00fc09de9461"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aedf495d121ed565e10f3bf","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":214},{"language":"default","tag":"Integrations","count":133},{"language":"default","tag":"Workflows","count":117},{"language":"default","tag":"Use Cases","count":112},{"language":"default","tag":"Actions","count":44},{"language":"default","tag":"Agents","count":36},{"language":"default","tag":"Sales","count":24},{"language":"default","tag":"Advanced","count":21},{"language":"default","tag":"Marketing","count":18},{"language":"default","tag":"Settings and admin","count":17}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/analytics/get-metrics-breakdown","slug":"/api-reference/analytics/get-metrics-breakdown","pageMetadata":{"title":"Get metrics breakdown","description":"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams.\n\n**Metrics and the dimensions they support** (`metric` and `groupBy`)\n- `credits`: `user`, `group`, `agent`, `workflow`, `source`\n- `chatMessages`: `user`, `group`, `agent`, `source`\n- `workflowRuns`: `user`, `group`, `workflow`\n- `meetingHours`: `user`, `group`\n- `meetings`: `user`, `group`\n\nFor `meetingHours` and `meetings`, each meeting counts toward the member it's attributed to, the person who first added the notetaker. To see who joined each meeting, use `/meetings`.\n\nNarrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.\n\nThe range is widened to whole days in UTC.\n\nRequires the Analytics permission (`analytics:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /metrics/breakdown","href":"/api-reference/analytics/get-metrics-breakdown","autogeneratedByOpenApi":true,"hidden":true},"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: \"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Metrics and the dimensions they support\"\n }), \" (\", _jsx(_components.code, {\n children: \"metric\"\n }), \" and \", _jsx(_components.code, {\n children: \"groupBy\"\n }), \")\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"credits\"\n }), \": \", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"group\"\n }), \", \", _jsx(_components.code, {\n children: \"agent\"\n }), \", \", _jsx(_components.code, {\n children: \"workflow\"\n }), \", \", _jsx(_components.code, {\n children: \"source\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"chatMessages\"\n }), \": \", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"group\"\n }), \", \", _jsx(_components.code, {\n children: \"agent\"\n }), \", \", _jsx(_components.code, {\n children: \"source\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"workflowRuns\"\n }), \": \", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"group\"\n }), \", \", _jsx(_components.code, {\n children: \"workflow\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"meetingHours\"\n }), \": \", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"group\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"meetings\"\n }), \": \", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"group\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For \", _jsx(_components.code, {\n children: \"meetingHours\"\n }), \" and \", _jsx(_components.code, {\n children: \"meetings\"\n }), \", each meeting counts toward the member it’s attributed to, the person who first added the notetaker. To see who joined each meeting, use \", _jsx(_components.code, {\n children: \"/meetings\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The range is widened to whole days in UTC.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the Analytics permission (\", _jsx(_components.code, {\n children: \"analytics:read\"\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get metrics breakdown","description":"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams.\n\n**Metrics and the dimensions they support** (`metric` and `groupBy`)\n- `credits`: `user`, `group`, `agent`, `workflow`, `source`\n- `chatMessages`: `user`, `group`, `agent`, `source`\n- `workflowRuns`: `user`, `group`, `workflow`\n- `meetingHours`: `user`, `group`\n- `meetings`: `user`, `group`\n\nFor `meetingHours` and `meetings`, each meeting counts toward the member it's attributed to, the person who first added the notetaker. To see who joined each meeting, use `/meetings`.\n\nNarrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.\n\nThe range is widened to whole days in UTC.\n\nRequires the Analytics permission (`analytics:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /metrics/breakdown","href":"/api-reference/analytics/get-metrics-breakdown","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getMetricsBreakdown","summary":"Get metrics breakdown","description":"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams.\n\n**Metrics and the dimensions they support** (`metric` and `groupBy`)\n- `credits`: `user`, `group`, `agent`, `workflow`, `source`\n- `chatMessages`: `user`, `group`, `agent`, `source`\n- `workflowRuns`: `user`, `group`, `workflow`\n- `meetingHours`: `user`, `group`\n- `meetings`: `user`, `group`\n\nFor `meetingHours` and `meetings`, each meeting counts toward the member it's attributed to, the person who first added the notetaker. To see who joined each meeting, use `/meetings`.\n\nNarrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.\n\nThe range is widened to whole days in UTC.\n\nRequires the Analytics permission (`analytics:read`).","tags":["Analytics"],"security":["47606e0a-660e-4949-a496-4317aaed3a35"],"parameters":["f819a7fb-80fb-40ac-98cb-2103ba6acccf","a6353f1b-afc1-4e89-9064-feb727009fa8","a120e051-60bb-499d-b195-b919bcf27ee9","1bd311e0-c422-4897-8d82-0390155ea4f5","b55ed291-c8e3-4b08-8f8e-f370d8553b33","14704c3b-8587-4bac-9f30-9bf08296cb62","63c45ff7-9f1e-4692-af86-df44f5bbacc2","3935da54-7318-4847-836b-82f6e0973b51","4c737dd7-2c05-4646-8227-b9b98fd5121b","16a8078a-1dab-4884-b849-32e5d19d9c6f","704bd159-15ce-4adc-88b5-dd364d60174b","ff0a4db0-d9a2-4e14-b0a7-1471d92f77f2","c037af2c-ce00-488c-95fb-50692ef2cc5b"],"responses":{"200":"aab83204-b2fe-4a2c-b798-414e4485e548","400":"0b358c54-a787-4adb-9090-2128730897b5","401":"d48a30c5-08be-4c6a-93fa-0a773c5daf36","403":"c6b5571b-b81f-468a-9eb0-da635a75cd00","404":"cdb4a2a2-e292-46e7-8f0f-9447901480ed","500":"60e963e6-d3d9-44e4-8a49-ae1ff2c6c4a5"},"method":"get","type":"path","servers":["01feda05-5951-43f0-aa13-35afeb50c0c7"],"path":"/metrics/breakdown","baseUrlOptions":["https://app.cassidyai.com/api/admin/v1"],"title":"Get metrics breakdown","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f819a7fb-80fb-40ac-98cb-2103ba6acccf":{"in":"query","name":"userId","schema":{"description":"Only count usage by this user. For `meetingHours` and `meetings`, only count meetings billed to them, which are the meetings they were first to add the notetaker to.","type":"string","uniqueKey":"","typeLabel":"string"},"description":"Only count usage by this user. For `meetingHours` and `meetings`, only count meetings billed to them, which are the meetings they were first to add the notetaker to."},"a6353f1b-afc1-4e89-9064-feb727009fa8":{"in":"query","name":"externalEmail","schema":{"description":"Only count usage by this external deployment user (e.g. such as a Slack, Microsoft Teams, Google Chat, or email user).","type":"string","uniqueKey":"","typeLabel":"string"},"description":"Only count usage by this external deployment user (e.g. such as a Slack, Microsoft Teams, Google Chat, or email user)."},"a120e051-60bb-499d-b195-b919bcf27ee9":{"in":"query","name":"groupId","schema":{"description":"Only count usage by members of this group. This uses current group membership, so it may include a member's usage from before they joined.","type":"string","uniqueKey":"","typeLabel":"string"},"description":"Only count usage by members of this group. This uses current group membership, so it may include a member's usage from before they joined."},"1bd311e0-c422-4897-8d82-0390155ea4f5":{"in":"query","name":"agentIds","schema":{"description":"Only include these Agents, using the IDs from the `agent` breakdown or `/chats`. Built-in models combine their thinking levels. Pass several as a comma-separated list.","maxItems":20,"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"uniqueKey":"","typeLabel":"string[]"},"description":"Only include these Agents, using the IDs from the `agent` breakdown or `/chats`. Built-in models combine their thinking levels. Pass several as a comma-separated list."},"b55ed291-c8e3-4b08-8f8e-f370d8553b33":{"in":"query","name":"excludeAgentIds","schema":{"description":"Leave out these Agents. Pass several as a comma-separated list.","maxItems":20,"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"uniqueKey":"","typeLabel":"string[]"},"description":"Leave out these Agents. Pass several as a comma-separated list."},"14704c3b-8587-4bac-9f30-9bf08296cb62":{"in":"query","name":"modelIds","schema":{"description":"Only include Agents that use these models, such as `claude-opus-5-5`, including the built-in model's own Agent. Agents count as the model they use today, so changing an Agent's model moves its past usage too. Thinking levels are combined. Pass several as a comma-separated list.","maxItems":20,"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"uniqueKey":"","typeLabel":"string[]"},"description":"Only include Agents that use these models, such as `claude-opus-5-5`, including the built-in model's own Agent. Agents count as the model they use today, so changing an Agent's model moves its past usage too. Thinking levels are combined. Pass several as a comma-separated list."},"63c45ff7-9f1e-4692-af86-df44f5bbacc2":{"in":"query","name":"excludeModelIds","schema":{"description":"Leave out Agents that use these models. Pass several as a comma-separated list.","maxItems":20,"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"uniqueKey":"","typeLabel":"string[]"},"description":"Leave out Agents that use these models. Pass several as a comma-separated list."},"3935da54-7318-4847-836b-82f6e0973b51":{"in":"query","name":"workflowId","schema":{"description":"Only count usage of this Workflow.","type":"string","uniqueKey":"","typeLabel":"string"},"description":"Only count usage of this Workflow."},"4c737dd7-2c05-4646-8227-b9b98fd5121b":{"in":"query","name":"source","schema":{"description":"Only count Agent chat usage from this source, such as `slack` or `web`. Available for `credits` and `chatMessages`; with `credits`, only Agent chat credits count.","type":"string","enum":["web","slack","teams","googleChat","embedded","email","api"],"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Only count Agent chat usage from this source, such as `slack` or `web`. Available for `credits` and `chatMessages`; with `credits`, only Agent chat credits count."},"16a8078a-1dab-4884-b849-32e5d19d9c6f":{"in":"query","name":"from","schema":{"type":"string","format":"date-time","description":"Inclusive start of the range as an ISO 8601 timestamp. Rounded down to the start of its bucket in UTC.","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":true,"description":"Inclusive start of the range as an ISO 8601 timestamp. Rounded down to the start of its bucket in UTC."},"704bd159-15ce-4adc-88b5-dd364d60174b":{"in":"query","name":"to","schema":{"type":"string","format":"date-time","description":"Exclusive end of the range as an ISO 8601 timestamp. Rounded up to the next bucket boundary in UTC.","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":true,"description":"Exclusive end of the range as an ISO 8601 timestamp. Rounded up to the next bucket boundary in UTC."},"ff0a4db0-d9a2-4e14-b0a7-1471d92f77f2":{"in":"query","name":"metric","schema":{"type":"string","enum":["credits","chatMessages","workflowRuns","meetingHours","meetings"],"description":"The metric to total.","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true,"description":"The metric to total."},"c037af2c-ce00-488c-95fb-50692ef2cc5b":{"in":"query","name":"groupBy","schema":{"type":"string","enum":["user","group","agent","workflow","source"],"description":"The dimension to total by. Not every metric supports every dimension; the error message lists the ones it does.","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true,"description":"The dimension to total by. Not every metric supports every dimension; the error message lists the ones it does."}},"responses":{"aab83204-b2fe-4a2c-b798-414e4485e548":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"metric":{"type":"string","enum":["credits","chatMessages","workflowRuns","meetingHours","meetings"],"isRequired":true,"uniqueKey":"metric","typeLabel":"enum\u003cstring>"},"groupBy":{"type":"string","enum":["user","group","agent","workflow","source"],"isRequired":true,"uniqueKey":"groupBy","typeLabel":"enum\u003cstring>"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"description":"ID of the user, group, Agent, or Workflow, or the source, such as `slack`. Null for external users.","type":"string","isRequired":true,"uniqueKey":"rows.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"description":"ID of the user, group, Agent, or Workflow, or the source, such as `slack`. Null for external users.","type":"null","isRequired":true,"uniqueKey":"rows.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].id","typeLabel":"string | null"},"name":{"type":"string","description":"Display name.","isRequired":true,"uniqueKey":"rows.items.[INDEX].name","typeLabel":"string"},"externalEmail":{"oneOf":[{"description":"When grouped by user, the email of a deployment user (for example from Slack or Microsoft Teams) who doesn't match any member's email.","type":"string","isRequired":true,"uniqueKey":"rows.items.[INDEX].externalEmail.oneOf.0","typeLabel":"string"},{"description":"When grouped by user, the email of a deployment user (for example from Slack or Microsoft Teams) who doesn't match any member's email.","type":"null","isRequired":true,"uniqueKey":"rows.items.[INDEX].externalEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].externalEmail","typeLabel":"string | null"},"value":{"type":"number","isRequired":true,"uniqueKey":"rows.items.[INDEX].value","typeLabel":"number"}},"required":["id","name","externalEmail","value"],"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"description":"Users, groups, Agents, Workflows, or sources with usage in the range, largest first. At most 10000 rows. Groups use current group membership, and a user in several groups counts toward each, so group values can overlap. Agent and source values count direct chats only, not usage inside Workflows, and built-in model Agents combine their thinking levels. For `meetingHours` and `meetings`, each meeting counts toward the member it's attributed to, the person who first added the notetaker.","isRequired":true,"uniqueKey":"rows","typeLabel":"object[]"},"truncated":{"type":"boolean","description":"True when more than 10000 rows had usage and only the largest were returned. Narrow the range or add a filter to see the rest.","isRequired":true,"uniqueKey":"truncated","typeLabel":"boolean"}},"required":["from","to","metric","groupBy","rows","truncated"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"from":"\u003cstring>","to":"\u003cstring>","metric":"credits","groupBy":"user","rows":[{"id":"\u003cstring>","name":"\u003cstring>","externalEmail":"\u003cstring>","value":123}],"truncated":true}}},"exampleType":"generated"}},"exampleType":"generated"},"0b358c54-a787-4adb-9090-2128730897b5":{"description":"Invalid input data","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Invalid input data","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Invalid input data error (400)","description":"The error information","example":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]},"uniqueKey":"","typeLabel":"Invalid input data error (400) · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d48a30c5-08be-4c6a-93fa-0a773c5daf36":{"description":"Authorization not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Authorization not provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Authorization not provided error (401)","description":"The error information","example":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]},"uniqueKey":"","typeLabel":"Authorization not provided error (401) · object"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"c6b5571b-b81f-468a-9eb0-da635a75cd00":{"description":"Insufficient access","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Insufficient access","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"FORBIDDEN","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Insufficient access error (403)","description":"The error information","example":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]},"uniqueKey":"","typeLabel":"Insufficient access error (403) · object"},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"cdb4a2a2-e292-46e7-8f0f-9447901480ed":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"NOT_FOUND","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Not found error (404)","description":"The error information","example":{"code":"NOT_FOUND","message":"Not found","issues":[]},"uniqueKey":"","typeLabel":"Not found error (404) · object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","message":"Not found","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"60e963e6-d3d9-44e4-8a49-ae1ff2c6c4a5":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Internal server error error (500)","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]},"uniqueKey":"","typeLabel":"Internal server error error (500) · object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"47606e0a-660e-4949-a496-4317aaed3a35":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An Admin API key, starting with `cas_admin_`.","scopes":["analytics:read"],"schemeName":"bearerAuth"}}},"servers":{"01feda05-5951-43f0-aa13-35afeb50c0c7":{"url":"https://app.cassidyai.com/api/admin/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An Admin API key, starting with `cas_admin_`.","scopes":["analytics:read"],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An Admin API key, starting with `cas_admin_`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"admin-api-openapi.json"},"subdomain":"cassidy","siteName":"Cassidy","title":"Get metrics breakdown - Cassidy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T18:34:05.024Z","originalFileLocation":"api-reference/analytics/get-metrics-breakdown.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=\"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams. Metrics and the dimensions they support (metric and groupBy) - credits: user, group, agent, workflow, source - chatMessages: user, group, agent, source - workflowRuns: user, group, workflow - meetingHours: user, group - meetings: user, group For meetingHours and meetings, each meeting counts toward the member it\u0026#x27;s attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings. Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below. The range is widened to whole days in UTC. Requires the Analytics permission (analytics:read).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cassidy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_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/cassidy/gcVXXkk00gvCM7Lb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get metrics breakdown - Cassidy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams. Metrics and the dimensions they support (metric and groupBy) - credits: user, group, agent, workflow, source - chatMessages: user, group, agent, source - workflowRuns: user, group, workflow - meetingHours: user, group - meetings: user, group For meetingHours and meetings, each meeting counts toward the member it\u0026#x27;s attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings. Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below. The range is widened to whole days in UTC. Requires the Analytics permission (analytics:read).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cassidy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cassidy.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Get+metrics+breakdown\u0026amp;description=Totals+one+metric+over+the+range+for+each+user%2C+group%2C+Agent%2C+Workflow%2C+or+source%2C+largest+first.+For+example%2C+credits+by+person%2C+Workflow+runs+by+Workflow%2C+or+\u0026amp;theme=45b88f546508cec88c9d93c2\u0026amp;signature=7a96144da228fede92cda7b969d5905a0254bd0fb7f9541d934fb7af0066c908\">\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 metrics breakdown - Cassidy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams. Metrics and the dimensions they support (metric and groupBy) - credits: user, group, agent, workflow, source - chatMessages: user, group, agent, source - workflowRuns: user, group, workflow - meetingHours: user, group - meetings: user, group For meetingHours and meetings, each meeting counts toward the member it\u0026#x27;s attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings. Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below. The range is widened to whole days in UTC. Requires the Analytics permission (analytics:read).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cassidy.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Get+metrics+breakdown\u0026amp;description=Totals+one+metric+over+the+range+for+each+user%2C+group%2C+Agent%2C+Workflow%2C+or+source%2C+largest+first.+For+example%2C+credits+by+person%2C+Workflow+runs+by+Workflow%2C+or+\u0026amp;theme=45b88f546508cec88c9d93c2\u0026amp;signature=7a96144da228fede92cda7b969d5905a0254bd0fb7f9541d934fb7af0066c908\">\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/cassidy/gcVXXkk00gvCM7Lb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cassidy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#325ED1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics/get-metrics-breakdown.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cassidyai.com/#organization\",\"name\":\"Cassidy\",\"url\":\"https://docs.cassidyai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cassidy/wE0GgFgF7sg6yClA/logo/light.svg?fit=max\u0026auto=format\u0026n=wE0GgFgF7sg6yClA\u0026q=85\u0026s=a282ef0ea39b2568b4c0d9164c38a471\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cassidyai.com#website\",\"name\":\"Cassidy\",\"url\":\"https://docs.cassidyai.com\",\"publisher\":{\"@id\":\"https://docs.cassidyai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown#webpage\",\"url\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown\",\"name\":\"Get metrics breakdown\",\"description\":\"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams. Metrics and the dimensions they support (metric and groupBy) - credits: user, group, agent, workflow, source - chatMessages: user, group, agent, source - workflowRuns: user, group, workflow - meetingHours: user, group - meetings: user, group For meetingHours and meetings, each meeting counts toward the member it's attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings. Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below. The range is widened to whole days in UTC. Requires the Analytics permission (analytics:read).\",\"dateModified\":\"2026-11-05T18:34:05.024Z\",\"isPartOf\":{\"@id\":\"https://docs.cassidyai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin API\",\"item\":\"https://docs.cassidyai.com/reference/admin-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Analytics\",\"item\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-timeseries\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get metrics breakdown\",\"item\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown#apireference\",\"headline\":\"Get metrics breakdown\",\"name\":\"Get metrics breakdown\",\"description\":\"Totals one metric over the range for each user, group, Agent, Workflow, or source, largest first. For example, credits by person, Workflow runs by Workflow, or chat messages by source, such as Slack or Microsoft Teams. Metrics and the dimensions they support (metric and groupBy) - credits: user, group, agent, workflow, source - chatMessages: user, group, agent, source - workflowRuns: user, group, workflow - meetingHours: user, group - meetings: user, group For meetingHours and meetings, each meeting counts toward the member it's attributed to, the person who first added the notetaker. To see who joined each meeting, use /meetings. Narrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below. The range is widened to whole days in UTC. Requires the Analytics permission (analytics:read).\",\"url\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cassidyai.com/api-reference/analytics/get-metrics-breakdown#webpage\"},\"dateModified\":\"2026-11-05T18:34:05.024Z\",\"publisher\":{\"@id\":\"https://docs.cassidyai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cassidyai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cassidy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cassidy","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Cassidy University","pages":[{"title":"Cassidy University","href":"/university"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/chatting-with-an-agent"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","hidden":true,"menu":[{"item":"Admin API","icon":"chart-column","description":"Pull organization-wide usage and activity.","groups":[{"group":"Admin API","pages":[{"title":"Pull usage analytics with the Admin API","description":"Create an Admin API key and pull organization-wide usage, Workflow runs, Agent chats, meetings, and Audit Logs into your own reports and dashboards.","icon":"chart-column","href":"/reference/admin-api"},{"group":"Analytics","pages":[{"title":"Get metrics timeseries","description":"Charts one metric across your organization over time, with a value for each time bucket and a total for the range.\n\n**Metrics** (`metric`)\n- `credits`: credits used across your organization\n- `meetingHours`: hours of meetings recorded\n- `meetings`: meetings recorded\n- `chatMessages`: messages sent to Agents\n- `workflowRuns`: Workflow runs\n\nEach meeting is attributed to one member, the person who first added the notetaker, so a person filter counts the meetings attributed to them. Totals include meetings deleted since.\n\n**Buckets** (`unit`)\n- `hour`, `day`, `week`, or `month`, in UTC. `credits` is available per day or coarser.\n\nNarrow the results to a person, group, Workflow, source, or specific Agents or models with the filters below.\n\nBuckets are in UTC, so daily totals can differ slightly from the Analytics dashboard, which uses your local time zone.\n\nRequires the Analytics permission (`analytics:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /metrics/timeseries","href":"/api-reference/analytics/get-metrics-timeseries"},{"title":"Get metrics breakdown","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /metrics/breakdown","href":"/api-reference/analytics/get-metrics-breakdown"}]},{"group":"Workflow runs","pages":[{"title":"List Workflow runs","description":"Lists individual Workflow runs started in the range, newest first.\n\n**Each run includes**\n- The Workflow and the person who started it\n- Its status, such as `success`, `failed`, or `running`\n- Whether it was a test run\n- The credits it used\n\nFilter by Workflow or person, or leave out test runs. Page through results with `cursor`.\n\n`credits` is null while a run is in progress.\n\nRequires the Workflow runs permission (`workflow_runs:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /workflow-runs","href":"/api-reference/workflow-runs/list-workflow-runs"}]},{"group":"Chats","pages":[{"title":"List chats","description":"Lists Agent chats started in the range, newest first.\n\n**Each chat includes**\n- Its name and most recent Agent\n- The person who started it\n- Where it happened (`source`), such as `web`, `slack`, `teams`, or `embedded`\n- When it started and when it was last active\n- The credits it used\n\nFilter by person, Agent, model, or source. Agent and model filters match the chat's most recent Agent, so a chat that switched Agents is listed under the one it uses now. Page through results with `cursor`.\n\nExcludes chats run by Workflows and Agent test chats. Messages are not included.\n\nRequires the Chats permission (`chats:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /chats","href":"/api-reference/chats/list-chats"}]},{"group":"Meetings","pages":[{"title":"List meetings","description":"Lists recorded meetings whose recording ended in the range, newest first.\n\n**Each meeting includes**\n- Its title and meeting platform\n- When recording started and ended, and the hours recorded\n- The members who added the notetaker\n- The members who joined, and how many other people joined\n\nFilter by a person to list the meetings they joined. Page through results with `cursor`.\n\nRequires the Meetings permission (`meetings:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /meetings","href":"/api-reference/meetings/list-meetings"}]},{"group":"Audit logs","pages":[{"title":"List audit logs","description":"Lists your organization's audit log events in the range, newest first by default. These are the same events as the [Audit Logs](https://docs.cassidyai.com/settings/audit-logs) page.\n\n**Each event includes**\n- What happened: its category, action, and operation type, such as `read` or `update`\n- Who did it: a user, an external user, an Admin API key, or the system\n- The resource it was about, and a related resource if there is one\n- When it happened, the IP address, and event-specific details\n\nFilter by category, actor, resource type and action, resource, or operation type. Page through results with `cursor`.\n\n**Polling mode**\n\nTo send events to your SIEM or another system, use polling mode: pass `order=asc` and `from` without `to`, then poll with each response's `nextCursor`. The cursor is always returned, even when there are no new events. Request the next page right away while `hasMore` is true, and wait for your next poll once it is false.\n\nEvents can take up to 2 minutes to appear, so polling never skips an event that is still being recorded.\n\nEach call to this endpoint records an audit log export event. Those events are filtered out of results for the Admin key that made the call. Other keys and the Audit Logs page still show them.\n\nRequires the Audit logs permission (`audit_logs:read`).","deprecated":null,"version":null,"openapi":"/admin-api-openapi.json get /audit-logs","href":"/api-reference/audit-logs/list-audit-logs"}]}]}]},{"item":"Agents API","icon":"robot","description":"Chat with your Agents from your own apps.","pages":[{"title":"Agents API","href":"/reference/agents-api"}]}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases"}]}]},"basePath":"","title":"Get metrics breakdown - Cassidy","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}