Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent’s overview over all time. Agents with no calls get zeros and nulls.
GET
/
v1
/
agent-analytics
/
overview
/
by-agent
Get call figures for several agents
curl --request GET \ --url https://api.tryhamsa.com/v1/agent-analytics/overview/by-agent \ --header 'Authorization: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hamsa API","colors":{"primary":"#1B5E3A","light":"#B4FD83","dark":"#2D7A4F"},"logo":{"light":"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_light.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=2576c2f27fed68b31fa686aca13e6fbf","dark":"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_dark.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=b89ad21e4d97ee72de3045482602bf53"},"favicon":"https://mintcdn.com/hamsa-452fa79a/2xrN5xxbhCUDZ-2o/favicon.svg?fit=max\u0026auto=format\u0026n=2xrN5xxbhCUDZ-2o\u0026q=85\u0026s=bebed50e7f5f9d0a6bddf1c7703677c1","navbar":{"links":[{"href":"https://tryhamsa.com/contact/","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://agents.tryhamsa.com/"}},"footer":{"socials":{"github":"https://github.com/hamsa-ai","linkedin":"https://www.linkedin.com/company/tryhamsa","website":"https://tryhamsa.com"}},"integrations":{"posthog":{"apiKey":"phc_3TCeimn6ufgVchZQ08TCRlIfu7Lwyaa8xGtBA67ym66","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hamsa-452fa79a","hasAudioNarration":false,"actualSubdomain":"hamsa-452fa79a","customDomains":["docs.tryhamsa.com"],"gitSource":{"type":"github","owner":"hamsa-dev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afdb1c93662950511af928a","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":210},{"language":"default","tag":"Agents Platform","count":72},{"language":"default","tag":"Media Platform","count":37},{"language":"default","tag":"Agent Versions \u0026 Drafts","count":19},{"language":"default","tag":"Flow agents","count":18},{"language":"default","tag":"Overview","count":17},{"language":"default","tag":"Knowledge Base Routes","count":16},{"language":"default","tag":"Web Tools Routes","count":14},{"language":"default","tag":"Step types","count":11},{"language":"default","tag":"Transcript Editing","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar>div>div>div>div:nth-child(3)>div{display:none!important}[data-theme=\"light\"] nav a[aria-current=\"page\"],[data-theme=\"light\"] nav a.active,[data-theme=\"light\"] .sidebar a[aria-current=\"page\"],[data-theme=\"light\"] .sidebar a.active,[data-theme=\"light\"] [style*=\"background\"][style*=\"#B4FD83\"],[data-theme=\"light\"] [style*=\"background\"][style*=\"rgb(180, 253, 131)\"]{background-color:#2D7A4F!important;color:#ffffff!important}[data-theme=\"dark\"] nav a[aria-current=\"page\"],[data-theme=\"dark\"] nav a.active,[data-theme=\"dark\"] .sidebar a[aria-current=\"page\"],[data-theme=\"dark\"] .sidebar a.active,[data-theme=\"dark\"] [style*=\"background\"][style*=\"#B4FD83\"],[data-theme=\"dark\"] [style*=\"background\"][style*=\"rgb(180, 253, 131)\"]{background-color:#B4FD83!important;color:#1a1a1a!important}[data-theme=\"light\"] button[class*=\"primary\"],[data-theme=\"light\"] .btn-primary{background-color:#2D7A4F!important;color:#ffffff!important}[data-theme=\"dark\"] button[class*=\"primary\"],[data-theme=\"dark\"] .btn-primary{background-color:#B4FD83!important;color:#1a1a1a!important}"}],"page":{"pagePath":"api-reference/endpoint/analytics-overview-by-agent","slug":"/api-reference/endpoint/analytics-overview-by-agent","pageMetadata":{"title":"Call Figures by Agent","description":"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent's overview over all time. Agents with no calls get zeros and `null`s.","deprecated":null,"version":null,"sidebarTitle":"Analytics overview by agent","openapi":"/api-reference/openapi.json get /v1/agent-analytics/overview/by-agent","href":"/api-reference/endpoint/analytics-overview-by-agent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent’s overview over all time. Agents with no calls get zeros and \", _jsx(_components.code, {\n children: \"null\"\n }), \"s.\"]\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":"Call Figures by Agent","description":"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent's overview over all time. Agents with no calls get zeros and `null`s.","deprecated":null,"version":null,"sidebarTitle":"Analytics overview by agent","openapi":"/api-reference/openapi.json get /v1/agent-analytics/overview/by-agent","href":"/api-reference/endpoint/analytics-overview-by-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get call figures for several agents","description":"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent's overview over all time. Agents with no calls get zeros and `null`s.","parameters":["90a96324-7ab5-4766-ba5c-17d34d974332"],"responses":{"200":"d556f51a-1c28-4d7b-ad5c-44065c9bd8c6","400":"26bef7f8-a0cc-4db7-ac53-2f750402b652","401":"42f4405a-e5a8-475e-a711-4c6ddb169cca","403":"2814ea93-4263-4f70-82b9-c9b29c821670","500":"6689ed87-fe05-403e-ae15-23180501ac48"},"security":["1241dc26-7b41-408f-8b34-cdbdb52e8a83"],"x-mint":{"metadata":{"title":"Call Figures by Agent"},"href":"/api-reference/endpoint/analytics-overview-by-agent"},"method":"get","type":"path","servers":["15b00970-8fc6-4e54-a3a6-b064f6aad46c"],"path":"/v1/agent-analytics/overview/by-agent","baseUrlOptions":["https://api.tryhamsa.com"],"title":"Get call figures for several agents","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"90a96324-7ab5-4766-ba5c-17d34d974332":{"in":"query","name":"agentIds","required":true,"style":"form","explode":true,"description":"Agent IDs, 1 to 30. Repeat the parameter (`agentIds=a\u0026agentIds=b`) or send a comma-separated list.","schema":{"type":"array","minItems":1,"maxItems":30,"items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"example":["48f7656f-098b-4c43-b165-7cfd2cc8ac30","6a1d7c52-93b0-4e1f-a7c4-2d8e5f9b0c31"],"isRequired":true,"description":"Agent IDs, 1 to 30. Repeat the parameter (`agentIds=a\u0026agentIds=b`) or send a comma-separated list.","uniqueKey":"","typeLabel":"string\u003cuuid>[]"}}},"responses":{"d556f51a-1c28-4d7b-ad5c-44065c9bd8c6":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"success","uniqueKey":"message","typeLabel":"string"},"data":{"type":"array","items":{"type":"object","properties":{"voiceAgentId":{"type":"string","format":"uuid","example":"48f7656f-098b-4c43-b165-7cfd2cc8ac30","uniqueKey":"data.items.[INDEX].voiceAgentId","typeLabel":"string\u003cuuid>"},"callStats":{"type":"object","properties":{"total":{"type":"integer","description":"All the agent's calls, all time, any status.","example":523,"uniqueKey":"data.items.[INDEX].callStats.total","typeLabel":"integer"},"live":{"type":"integer","description":"Calls in progress that started in the last 10 minutes.","example":2,"uniqueKey":"data.items.[INDEX].callStats.live","typeLabel":"integer"},"averageDurationSeconds":{"oneOf":[{"type":"number","description":"Average length of finished calls, in seconds. `null` when the agent has no calls.","example":11.08,"uniqueKey":"data.items.[INDEX].callStats.averageDurationSeconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Average length of finished calls, in seconds. `null` when the agent has no calls.","example":11.08,"uniqueKey":"data.items.[INDEX].callStats.averageDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].callStats.averageDurationSeconds","typeLabel":"number | null"},"transferredToPersonPercent":{"oneOf":[{"type":"number","description":"Percentage (0-100) of analysed finished calls handed to a person. `null` when the agent has no calls.","example":4.5,"uniqueKey":"data.items.[INDEX].callStats.transferredToPersonPercent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percentage (0-100) of analysed finished calls handed to a person. `null` when the agent has no calls.","example":4.5,"uniqueKey":"data.items.[INDEX].callStats.transferredToPersonPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].callStats.transferredToPersonPercent","typeLabel":"number | null"}},"uniqueKey":"data.items.[INDEX].callStats","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"example":[{"voiceAgentId":"48f7656f-098b-4c43-b165-7cfd2cc8ac30","callStats":{"total":523,"live":2,"averageDurationSeconds":11.08,"transferredToPersonPercent":4.5}},{"voiceAgentId":"6a1d7c52-93b0-4e1f-a7c4-2d8e5f9b0c31","callStats":{"total":0,"live":0,"averageDurationSeconds":null,"transferredToPersonPercent":null}}],"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"success","data":[{"voiceAgentId":"48f7656f-098b-4c43-b165-7cfd2cc8ac30","callStats":{"total":523,"live":2,"averageDurationSeconds":11.08,"transferredToPersonPercent":4.5}},{"voiceAgentId":"6a1d7c52-93b0-4e1f-a7c4-2d8e5f9b0c31","callStats":{"total":0,"live":0,"averageDurationSeconds":null,"transferredToPersonPercent":null}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"26bef7f8-a0cc-4db7-ac53-2f750402b652":{"description":"Missing `agentIds`, more than 30, or an ID that is not a UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Service error code: the HTTP status with a service prefix (for example `8404`). Missing when the service has no code for that status.","example":8404,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong. Some services (calls and recordings) put the error key here, for example `CallNotFoundOrUnavailable`, and send no `messageKey`.","example":"Policy not found!","uniqueKey":"message","typeLabel":"string"},"messageKey":{"type":"string","description":"Stable key for the error, safe to match on in code. Not returned by every service.","example":"PolicyNotFound","uniqueKey":"messageKey","typeLabel":"string"},"params":{"type":"object","additionalProperties":true,"description":"Details for some errors (for example `reason`). Not returned by every service.","example":{"reason":"NO_DRAFT"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":8404,"message":"Policy not found!","messageKey":"PolicyNotFound","params":{"reason":"NO_DRAFT"}}}},"exampleType":"generated"}},"exampleType":"generated"},"42f4405a-e5a8-475e-a711-4c6ddb169cca":{"description":"Unauthorized: missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Service error code: the HTTP status with a service prefix (for example `8404`). Missing when the service has no code for that status.","example":8404,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong. Some services (calls and recordings) put the error key here, for example `CallNotFoundOrUnavailable`, and send no `messageKey`.","example":"Policy not found!","uniqueKey":"message","typeLabel":"string"},"messageKey":{"type":"string","description":"Stable key for the error, safe to match on in code. Not returned by every service.","example":"PolicyNotFound","uniqueKey":"messageKey","typeLabel":"string"},"params":{"type":"object","additionalProperties":true,"description":"Details for some errors (for example `reason`). Not returned by every service.","example":{"reason":"NO_DRAFT"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":8404,"message":"Policy not found!","messageKey":"PolicyNotFound","params":{"reason":"NO_DRAFT"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2814ea93-4263-4f70-82b9-c9b29c821670":{"description":"Your API key or role does not have the `statistics:read` permission.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Service error code: the HTTP status with a service prefix (for example `8404`). Missing when the service has no code for that status.","example":8404,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong. Some services (calls and recordings) put the error key here, for example `CallNotFoundOrUnavailable`, and send no `messageKey`.","example":"Policy not found!","uniqueKey":"message","typeLabel":"string"},"messageKey":{"type":"string","description":"Stable key for the error, safe to match on in code. Not returned by every service.","example":"PolicyNotFound","uniqueKey":"messageKey","typeLabel":"string"},"params":{"type":"object","additionalProperties":true,"description":"Details for some errors (for example `reason`). Not returned by every service.","example":{"reason":"NO_DRAFT"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":8404,"message":"Policy not found!","messageKey":"PolicyNotFound","params":{"reason":"NO_DRAFT"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6689ed87-fe05-403e-ae15-23180501ac48":{"description":"Server Side Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Service error code: the HTTP status with a service prefix (for example `8404`). Missing when the service has no code for that status.","example":8404,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong. Some services (calls and recordings) put the error key here, for example `CallNotFoundOrUnavailable`, and send no `messageKey`.","example":"Policy not found!","uniqueKey":"message","typeLabel":"string"},"messageKey":{"type":"string","description":"Stable key for the error, safe to match on in code. Not returned by every service.","example":"PolicyNotFound","uniqueKey":"messageKey","typeLabel":"string"},"params":{"type":"object","additionalProperties":true,"description":"Details for some errors (for example `reason`). Not returned by every service.","example":{"reason":"NO_DRAFT"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":8404,"message":"Policy not found!","messageKey":"PolicyNotFound","params":{"reason":"NO_DRAFT"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1241dc26-7b41-408f-8b34-cdbdb52e8a83":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"15b00970-8fc6-4e54-a3a6-b064f6aad46c":{"url":"https://api.tryhamsa.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"hamsa-452fa79a","siteName":"Hamsa API","title":"Call Figures by Agent - Hamsa API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T14:10:34.461Z","originalFileLocation":"api-reference/endpoint/analytics-overview-by-agent.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=\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent\u0026#x27;s overview over all time. Agents with no calls get zeros and nulls.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hamsa API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Call Figures by Agent - Hamsa API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent\u0026#x27;s overview over all time. Agents with no calls get zeros and nulls.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hamsa API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hamsa-452fa79a.mintlify.site/_mintlify/api/og/v2?division=Agents+Analytics+and+Performance+Metrics\u0026amp;title=Call+Figures+by+Agent\u0026amp;description=Returns+all-time+call+figures+for+up+to+30+agents+in+one+request%2C+in+the+order+you+asked+%28each+agent+once%2C+duplicates+removed%29.+Each+figure+matches+the+agent%27s+\u0026amp;theme=7ec8a8f4dee4600e0cac89a6\u0026amp;signature=0e2c68b013d648dd573a84678624eb5c2002899650c8dcabd4591a5f7a8e2212\">\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=\"Call Figures by Agent - Hamsa API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent\u0026#x27;s overview over all time. Agents with no calls get zeros and nulls.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hamsa-452fa79a.mintlify.site/_mintlify/api/og/v2?division=Agents+Analytics+and+Performance+Metrics\u0026amp;title=Call+Figures+by+Agent\u0026amp;description=Returns+all-time+call+figures+for+up+to+30+agents+in+one+request%2C+in+the+order+you+asked+%28each+agent+once%2C+duplicates+removed%29.+Each+figure+matches+the+agent%27s+\u0026amp;theme=7ec8a8f4dee4600e0cac89a6\u0026amp;signature=0e2c68b013d648dd573a84678624eb5c2002899650c8dcabd4591a5f7a8e2212\">\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/hamsa-452fa79a/8JpC4CFKwIaeE6HH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hamsa API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B5E3A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/analytics-overview-by-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tryhamsa.com/#organization\",\"name\":\"Hamsa API\",\"url\":\"https://docs.tryhamsa.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_light.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=2576c2f27fed68b31fa686aca13e6fbf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tryhamsa.com#website\",\"name\":\"Hamsa API\",\"url\":\"https://docs.tryhamsa.com\",\"publisher\":{\"@id\":\"https://docs.tryhamsa.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent#webpage\",\"url\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent\",\"name\":\"Call Figures by Agent\",\"description\":\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent's overview over all time. Agents with no calls get zeros and nulls.\",\"dateModified\":\"2026-11-18T14:10:34.461Z\",\"isPartOf\":{\"@id\":\"https://docs.tryhamsa.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents Analytics and Performance Metrics\",\"item\":\"https://docs.tryhamsa.com/api-reference/endpoint/get-overview-analytics\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Call Figures by Agent\",\"item\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent#apireference\",\"headline\":\"Call Figures by Agent\",\"name\":\"Call Figures by Agent\",\"description\":\"Returns all-time call figures for up to 30 agents in one request, in the order you asked (each agent once, duplicates removed). Each figure matches the agent's overview over all time. Agents with no calls get zeros and nulls.\",\"url\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/analytics-overview-by-agent#webpage\"},\"dateModified\":\"2026-11-18T14:10:34.461Z\",\"publisher\":{\"@id\":\"https://docs.tryhamsa.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tryhamsa.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hamsa API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hamsa API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/analytics-overview-by-agent.md","siteName":"Hamsa API","nav":{"global":null,"tabs":[{"tab":"Overview","icon":"list-timeline","pages":[{"title":"Overview","href":"/overview/introduction"}]},{"tab":"Text to Speech","icon":"message-waveform","pages":[{"title":"Text to Speech","href":"/text-to-speech/introduction"}]},{"tab":"Speech to Text","icon":"head-side-speak","pages":[{"title":"Speech to Text","href":"/speech-to-text/introduction"}]},{"tab":"Agents Platform","icon":"user-robot","pages":[{"title":"Agents Platform","href":"/agents/introduction"}]},{"tab":"Media Platform","icon":"photo-film-music","pages":[{"title":"Media Platform","href":"/media/introduction"}]},{"tab":"Developers","icon":"square-terminal","pages":[{"title":"Developers","href":"/developers/apis/quick-start"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Real Time Routes","pages":[{"title":"Generate Text to Speech File Data","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts","openapi":"/api-reference/openapi.json post /v1/realtime/tts","href":"/api-reference/endpoint/rt-generate-tts"},{"title":"Generate Streamed Text to Speech File Data","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts stream","openapi":"/api-reference/openapi.json post /v1/realtime/tts-stream","href":"/api-reference/endpoint/rt-generate-tts-stream"},{"title":"Generate Speech to Text Transcription","deprecated":null,"version":null,"sidebarTitle":"Rt generate stt","openapi":"/api-reference/openapi.json post /v1/realtime/stt","href":"/api-reference/endpoint/rt-generate-stt"},{"title":"Connector TTS Stream","deprecated":null,"version":null,"sidebarTitle":"Connector tts stream","openapi":"/api-reference/openapi.json post /v1/realtime/connector/tts-stream","href":"/api-reference/endpoint/connector-tts-stream"},{"title":"Generate Speech with Style (v3)","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts v3","openapi":"/api-reference/openapi.json post /v3/realtime/tts","href":"/api-reference/endpoint/rt-generate-tts-v3"},{"title":"Stream Speech with Style (v3)","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts stream v3","openapi":"/api-reference/openapi.json post /v3/realtime/tts-stream","href":"/api-reference/endpoint/rt-generate-tts-stream-v3"},{"title":"Connector TTS Stream with Style (v3)","deprecated":null,"version":null,"sidebarTitle":"Connector tts stream v3","openapi":"/api-reference/openapi.json post /v3/realtime/connector/tts-stream","href":"/api-reference/endpoint/connector-tts-stream-v3"}]},{"group":"Speech-to-Text Routes","pages":[{"title":"Create Speech to Text","deprecated":null,"version":null,"sidebarTitle":"Create job v2","openapi":"/api-reference/openapi.json post /v2/jobs","href":"/api-reference/endpoint/create-job-v2"}]},{"group":"Transcript Editing","pages":[{"title":"List Transcript Segments","deprecated":null,"version":null,"sidebarTitle":"List transcript segments","openapi":"/api-reference/openapi.json get /v2/transcript-jobs/{jobId}/transcripts","href":"/api-reference/endpoint/list-transcript-segments"},{"title":"Add Transcript Segment","deprecated":null,"version":null,"sidebarTitle":"Add transcript segment","openapi":"/api-reference/openapi.json post /v2/transcript-jobs/{jobId}/transcripts","href":"/api-reference/endpoint/add-transcript-segment"},{"title":"Edit Transcript Segment","deprecated":null,"version":null,"sidebarTitle":"Edit transcript segment","openapi":"/api-reference/openapi.json patch /v2/transcript-jobs/{jobId}/transcripts/{transcriptId}","href":"/api-reference/endpoint/edit-transcript-segment"},{"title":"Delete Transcript Segment","deprecated":null,"version":null,"sidebarTitle":"Delete transcript segment","openapi":"/api-reference/openapi.json delete /v2/transcript-jobs/{jobId}/transcripts/{transcriptId}","href":"/api-reference/endpoint/delete-transcript-segment"},{"title":"Export Transcript","deprecated":null,"version":null,"sidebarTitle":"Export transcript","openapi":"/api-reference/openapi.json get /v2/transcript-jobs/{jobId}/transcripts/export","href":"/api-reference/endpoint/export-transcript"},{"title":"List Transcript Speakers","deprecated":null,"version":null,"sidebarTitle":"List transcript speakers","openapi":"/api-reference/openapi.json get /v2/transcript-jobs/{jobId}/speakers","href":"/api-reference/endpoint/list-transcript-speakers"},{"title":"Add Transcript Speaker","deprecated":null,"version":null,"sidebarTitle":"Add transcript speaker","openapi":"/api-reference/openapi.json post /v2/transcript-jobs/{jobId}/speakers","href":"/api-reference/endpoint/add-transcript-speaker"},{"title":"Rename Transcript Speaker","deprecated":null,"version":null,"sidebarTitle":"Rename transcript speaker","openapi":"/api-reference/openapi.json patch /v2/transcript-jobs/{jobId}/speakers/{speakerId}","href":"/api-reference/endpoint/rename-transcript-speaker"},{"title":"Delete Transcript Speaker","deprecated":null,"version":null,"sidebarTitle":"Delete transcript speaker","openapi":"/api-reference/openapi.json delete /v2/transcript-jobs/{jobId}/speakers/{speakerId}","href":"/api-reference/endpoint/delete-transcript-speaker"},{"title":"Merge Transcript Speakers","deprecated":null,"version":null,"sidebarTitle":"Merge transcript speakers","openapi":"/api-reference/openapi.json post /v2/transcript-jobs/{jobId}/speakers/merge","href":"/api-reference/endpoint/merge-transcript-speakers"}]},{"group":"Text to Speech Routes","pages":[{"title":"Generate Text to Speech Route","deprecated":null,"version":null,"sidebarTitle":"Generate tts","openapi":"/api-reference/openapi.json post /v1/jobs/text-to-speech","href":"/api-reference/endpoint/generate-tts"},{"title":"Preload Cloned TTS Voice","deprecated":null,"version":null,"sidebarTitle":"Preload cloned tts voice","openapi":"/api-reference/openapi.json post /v2/tts/voices/custom/preload","href":"/api-reference/endpoint/preload-cloned-tts-voice"},{"title":"Create TTS history","deprecated":null,"version":null,"sidebarTitle":"Create tts history","openapi":"/api-reference/openapi.json post /v2/tts/histories","href":"/api-reference/create-tts-history"},{"title":"List TTS histories","deprecated":null,"version":null,"sidebarTitle":"List tts histories","openapi":"/api-reference/openapi.json get /v2/tts/histories","href":"/api-reference/list-tts-histories"},{"title":"Get TTS history","deprecated":null,"version":null,"sidebarTitle":"Get tts history","openapi":"/api-reference/openapi.json get /v2/tts/histories/{id}","href":"/api-reference/get-tts-history"},{"title":"Delete TTS history","deprecated":null,"version":null,"sidebarTitle":"Delete tts history","openapi":"/api-reference/openapi.json delete /v2/tts/histories/{id}","href":"/api-reference/delete-tts-history"},{"title":"Voice Catalog","deprecated":null,"version":null,"sidebarTitle":"Tts voice catalog","openapi":"/api-reference/openapi.json get /v2/tts/voices/catalog","href":"/api-reference/endpoint/tts-voice-catalog"}]},{"group":"Phone Numbers Routes","pages":[{"title":"Add Phone Number to a User Route","deprecated":null,"version":null,"sidebarTitle":"Add phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/phone-number","href":"/api-reference/endpoint/add-phone-number"},{"title":"Get Phone Number by its ID Route","deprecated":null,"version":null,"sidebarTitle":"Get phone number","openapi":"/api-reference/openapi.json get /v1/voice-agents/phone-number","href":"/api-reference/endpoint/get-phone-number"},{"title":"Delete Phone Number","deprecated":null,"version":null,"sidebarTitle":"Delete phone number","openapi":"/api-reference/openapi.json delete /v1/voice-agents/phone-number","href":"/api-reference/endpoint/delete-phone-number"},{"title":"Assign Phone Number to a Voice Agent Route","deprecated":null,"version":null,"sidebarTitle":"Assign phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/assign-number","href":"/api-reference/endpoint/assign-phone-number"},{"title":"Unassign Phone Number","deprecated":null,"version":null,"sidebarTitle":"Unassign phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/phone-number/unassign","href":"/api-reference/endpoint/unassign-phone-number"},{"title":"List User Phone Numbers Route","deprecated":null,"version":null,"sidebarTitle":"List phone numbers","openapi":"/api-reference/openapi.json get /v1/voice-agents/phone-number/list","href":"/api-reference/endpoint/list-phone-numbers"},{"title":"Create an Outbound Call","deprecated":null,"version":null,"sidebarTitle":"Call phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/phone-number/call","href":"/api-reference/endpoint/call-phone-number"}]},{"group":"Voice Agents Routes","pages":[{"title":"Clone Voice Agent Route","deprecated":null,"version":null,"sidebarTitle":"Clone voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents/clone","href":"/api-reference/endpoint/clone-voice-agent"},{"title":"Create Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Create voice agent v2","openapi":"/api-reference/openapi.json post /v2/voice-agents","href":"/api-reference/endpoint/create-voice-agent-v2"},{"title":"List Voice Agents","deprecated":null,"version":null,"sidebarTitle":"List voice agents v2","openapi":"/api-reference/openapi.json get /v2/voice-agents","href":"/api-reference/endpoint/list-voice-agents-v2"},{"title":"Get Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Get voice agent v2","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/get-voice-agent-v2"},{"title":"Update Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Update voice agent v2","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/update-voice-agent-v2"},{"title":"Delete Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Delete voice agent","openapi":"/api-reference/openapi.json delete /v1/voice-agents","href":"/api-reference/endpoint/delete-voice-agent"},{"title":"List LLM Models","deprecated":null,"version":null,"sidebarTitle":"Llm catalog","openapi":"/api-reference/openapi.json get /v1/voice-agents/llm-catalog","href":"/api-reference/endpoint/llm-catalog"}]},{"group":"Agent Versions \u0026 Drafts","pages":[{"title":"List Agent Versions","deprecated":null,"version":null,"sidebarTitle":"List agent versions","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/versions","href":"/api-reference/endpoint/list-agent-versions"},{"title":"Get Agent Version","deprecated":null,"version":null,"sidebarTitle":"Get agent version","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/versions/{versionId}","href":"/api-reference/endpoint/get-agent-version"},{"title":"Update Agent Version","deprecated":null,"version":null,"sidebarTitle":"Update agent version","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}/versions/{versionId}","href":"/api-reference/endpoint/update-agent-version"},{"title":"Restore Agent Version","deprecated":null,"version":null,"sidebarTitle":"Restore agent version","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/versions/{versionId}/restore","href":"/api-reference/endpoint/restore-agent-version"},{"title":"Get Current Agent Version","deprecated":null,"version":null,"sidebarTitle":"Get current agent version","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/current-version","href":"/api-reference/endpoint/get-current-agent-version"},{"title":"Turn On Agent Deployments","deprecated":null,"version":null,"sidebarTitle":"Enable agent versioning","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/versioning:enable","href":"/api-reference/endpoint/enable-agent-versioning"},{"title":"Get Agent Deployment","deprecated":null,"version":null,"sidebarTitle":"Get agent deployment","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/deployment","href":"/api-reference/endpoint/get-agent-deployment"},{"title":"Set Agent Deployment","deprecated":null,"version":null,"sidebarTitle":"Set agent deployment","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/deployment","href":"/api-reference/endpoint/set-agent-deployment"},{"title":"Get Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Get agent draft","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/draft","href":"/api-reference/endpoint/get-agent-draft"},{"title":"Save Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Save agent draft","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/draft","href":"/api-reference/endpoint/save-agent-draft"},{"title":"Get Agent Draft Status","deprecated":null,"version":null,"sidebarTitle":"Get agent draft status","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/draft-status","href":"/api-reference/endpoint/get-agent-draft-status"},{"title":"Propose Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Propose agent draft","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/draft/propose","href":"/api-reference/endpoint/propose-agent-draft"},{"title":"Withdraw Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Withdraw agent draft","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/draft/withdraw","href":"/api-reference/endpoint/withdraw-agent-draft"},{"title":"Rebase Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Rebase agent draft","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/draft/rebase","href":"/api-reference/endpoint/rebase-agent-draft"},{"title":"List Agent Drafts","deprecated":null,"version":null,"sidebarTitle":"List agent drafts","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/drafts","href":"/api-reference/endpoint/list-agent-drafts"},{"title":"Get Agent Draft by ID","deprecated":null,"version":null,"sidebarTitle":"Get agent draft by id","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/drafts/{draftId}","href":"/api-reference/endpoint/get-agent-draft-by-id"},{"title":"Discard Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Discard agent draft","openapi":"/api-reference/openapi.json delete /v2/voice-agents/{voiceAgentId}/drafts/{draftId}","href":"/api-reference/endpoint/discard-agent-draft"},{"title":"Restore Agent Draft","deprecated":null,"version":null,"sidebarTitle":"Restore agent draft","openapi":"/api-reference/openapi.json post /v2/voice-agents/{voiceAgentId}/drafts/{draftId}/restore","href":"/api-reference/endpoint/restore-agent-draft"},{"title":"List Project Draft Proposals","deprecated":null,"version":null,"sidebarTitle":"List project draft proposals","openapi":"/api-reference/openapi.json get /v2/voice-agents/proposals","href":"/api-reference/endpoint/list-project-draft-proposals"}]},{"group":"Agent Environments","pages":[{"title":"List Agent Environments","deprecated":null,"version":null,"sidebarTitle":"List agent environments","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/environments","href":"/api-reference/endpoint/list-agent-environments"},{"title":"Save Agent Environment Values","deprecated":null,"version":null,"sidebarTitle":"Save agent environments","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/environments","href":"/api-reference/endpoint/save-agent-environments"},{"title":"Deploy Version to Environment","deprecated":null,"version":null,"sidebarTitle":"Deploy version to environment","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/environments/{environmentId}/version","href":"/api-reference/endpoint/deploy-version-to-environment"},{"title":"Get Environment Deploy History","deprecated":null,"version":null,"sidebarTitle":"Get environment history","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/environments/{environmentId}/history","href":"/api-reference/endpoint/get-environment-history"},{"title":"List Phone Number Environments","deprecated":null,"version":null,"sidebarTitle":"List phone number environments","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/phone-numbers/environments","href":"/api-reference/endpoint/list-phone-number-environments"},{"title":"Move Phone Number to Environment","deprecated":null,"version":null,"sidebarTitle":"Set phone number environment","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/phone-numbers/{phoneNumberId}/environment","href":"/api-reference/endpoint/set-phone-number-environment"}]},{"group":"Call Tokens","pages":[{"title":"Create Call Token","deprecated":null,"version":null,"sidebarTitle":"Create call token","openapi":"/api-reference/openapi.json post /v1/voice-agents/call-token","href":"/api-reference/endpoint/create-call-token"}]},{"group":"Policies","pages":[{"title":"List Policies","deprecated":null,"version":null,"sidebarTitle":"List policies","openapi":"/api-reference/openapi.json get /v2/voice-agents/policies","href":"/api-reference/endpoint/list-policies"},{"title":"Create Policy","deprecated":null,"version":null,"sidebarTitle":"Create policy","openapi":"/api-reference/openapi.json post /v2/voice-agents/policies","href":"/api-reference/endpoint/create-policy"},{"title":"Get Policy","deprecated":null,"version":null,"sidebarTitle":"Get policy","openapi":"/api-reference/openapi.json get /v2/voice-agents/policies/{policyId}","href":"/api-reference/endpoint/get-policy"},{"title":"Update Policy","deprecated":null,"version":null,"sidebarTitle":"Update policy","openapi":"/api-reference/openapi.json patch /v2/voice-agents/policies/{policyId}","href":"/api-reference/endpoint/update-policy"},{"title":"Delete Policy","deprecated":null,"version":null,"sidebarTitle":"Delete policy","openapi":"/api-reference/openapi.json delete /v2/voice-agents/policies/{policyId}","href":"/api-reference/endpoint/delete-policy"},{"title":"List Agent Policies","deprecated":null,"version":null,"sidebarTitle":"List agent policies","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/policies","href":"/api-reference/endpoint/list-agent-policies"},{"title":"Set Agent Policies","deprecated":null,"version":null,"sidebarTitle":"Set agent policies","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/policies","href":"/api-reference/endpoint/set-agent-policies"},{"title":"Toggle Agent Policy","deprecated":null,"version":null,"sidebarTitle":"Toggle agent policy","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}/policies/{policyId}","href":"/api-reference/endpoint/toggle-agent-policy"}]},{"group":"Guardrails","pages":[{"title":"List Guardrails","deprecated":null,"version":null,"sidebarTitle":"List guardrails","openapi":"/api-reference/openapi.json get /v2/voice-agents/guardrails","href":"/api-reference/endpoint/list-guardrails"},{"title":"Create Guardrail","deprecated":null,"version":null,"sidebarTitle":"Create guardrail","openapi":"/api-reference/openapi.json post /v2/voice-agents/guardrails","href":"/api-reference/endpoint/create-guardrail"},{"title":"Get Guardrail","deprecated":null,"version":null,"sidebarTitle":"Get guardrail","openapi":"/api-reference/openapi.json get /v2/voice-agents/guardrails/{guardrailId}","href":"/api-reference/endpoint/get-guardrail"},{"title":"Update Guardrail","deprecated":null,"version":null,"sidebarTitle":"Update guardrail","openapi":"/api-reference/openapi.json patch /v2/voice-agents/guardrails/{guardrailId}","href":"/api-reference/endpoint/update-guardrail"},{"title":"Delete Guardrail","deprecated":null,"version":null,"sidebarTitle":"Delete guardrail","openapi":"/api-reference/openapi.json delete /v2/voice-agents/guardrails/{guardrailId}","href":"/api-reference/endpoint/delete-guardrail"},{"title":"List Agent Guardrails","deprecated":null,"version":null,"sidebarTitle":"List agent guardrails","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/guardrails","href":"/api-reference/endpoint/list-agent-guardrails"},{"title":"Set Agent Guardrails","deprecated":null,"version":null,"sidebarTitle":"Set agent guardrails","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/guardrails","href":"/api-reference/endpoint/set-agent-guardrails"},{"title":"Toggle Agent Guardrail","deprecated":null,"version":null,"sidebarTitle":"Toggle agent guardrail","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}/guardrails/{guardrailId}","href":"/api-reference/endpoint/toggle-agent-guardrail"}]},{"group":"Functions \u0026 Macros","pages":[{"title":"List Functions and Macros","deprecated":null,"version":null,"sidebarTitle":"List functions macros","openapi":"/api-reference/openapi.json get /v2/voice-agents/functions-macros","href":"/api-reference/endpoint/list-functions-macros"},{"title":"Create Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Create function macro","openapi":"/api-reference/openapi.json post /v2/voice-agents/functions-macros","href":"/api-reference/endpoint/create-function-macro"},{"title":"Try Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Test function macro","openapi":"/api-reference/openapi.json post /v2/voice-agents/functions-macros/test","href":"/api-reference/endpoint/test-function-macro"},{"title":"Get Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Get function macro","openapi":"/api-reference/openapi.json get /v2/voice-agents/functions-macros/{functionMacroId}","href":"/api-reference/endpoint/get-function-macro"},{"title":"Update Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Update function macro","openapi":"/api-reference/openapi.json patch /v2/voice-agents/functions-macros/{functionMacroId}","href":"/api-reference/endpoint/update-function-macro"},{"title":"Delete Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Delete function macro","openapi":"/api-reference/openapi.json delete /v2/voice-agents/functions-macros/{functionMacroId}","href":"/api-reference/endpoint/delete-function-macro"},{"title":"List Agent Functions and Macros","deprecated":null,"version":null,"sidebarTitle":"List agent functions macros","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}/functions-macros","href":"/api-reference/endpoint/list-agent-functions-macros"},{"title":"Set Agent Functions and Macros","deprecated":null,"version":null,"sidebarTitle":"Set agent functions macros","openapi":"/api-reference/openapi.json put /v2/voice-agents/{voiceAgentId}/functions-macros","href":"/api-reference/endpoint/set-agent-functions-macros"},{"title":"Toggle Agent Function or Macro","deprecated":null,"version":null,"sidebarTitle":"Toggle agent function macro","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}/functions-macros/{functionMacroId}","href":"/api-reference/endpoint/toggle-agent-function-macro"}]},{"group":"Voice Cloning","pages":[{"title":"List TTS voices","deprecated":null,"version":null,"sidebarTitle":"List tts voices","openapi":"/api-reference/openapi.json get /v2/tts/voices","href":"/api-reference/list-tts-voices"},{"title":"Create TTS voice","deprecated":null,"version":null,"sidebarTitle":"Create tts voice","openapi":"/api-reference/openapi.json post /v2/tts/voices","href":"/api-reference/create-tts-voice"},{"title":"List dialects","deprecated":null,"version":null,"sidebarTitle":"List dialects","openapi":"/api-reference/openapi.json get /v2/tts/dialects","href":"/api-reference/list-dialects"},{"title":"Favorite a TTS voice","deprecated":null,"version":null,"sidebarTitle":"Favorite a tts voice","openapi":"/api-reference/openapi.json post /v2/tts/voices/{id}/favourite","href":"/api-reference/favorite-a-tts-voice"},{"title":"Delete TTS voice","deprecated":null,"version":null,"sidebarTitle":"Delete tts voice","openapi":"/api-reference/openapi.json delete /v2/tts/voices/{id}","href":"/api-reference/delete-tts-voice"},{"title":"Get TTS voice","deprecated":null,"version":null,"sidebarTitle":"Get tts voice","openapi":"/api-reference/openapi.json get /v2/tts/voices/{id}","href":"/api-reference/get-tts-voice"},{"title":"Preview TTS voice","deprecated":null,"version":null,"sidebarTitle":"Preview tts voice","openapi":"/api-reference/openapi.json post /v2/tts/voices/preview","href":"/api-reference/preview-tts-voice"},{"title":"Get default TTS voice","deprecated":null,"version":null,"sidebarTitle":"Get default tts voice","openapi":"/api-reference/openapi.json get /v2/tts/voices/default/current","href":"/api-reference/get-default-tts-voice"},{"title":"Extract transcription from voice audio","deprecated":null,"version":null,"sidebarTitle":"Extract transcription from voice audio","openapi":"/api-reference/openapi.json post /v2/tts/voices/extract-transcription","href":"/api-reference/extract-transcription-from-voice-audio"}]},{"group":"Call Conversations","pages":[{"title":"List Call Records (Minimal)","deprecated":null,"version":null,"sidebarTitle":"List minimal calls","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversations/minimal-list","href":"/api-reference/endpoint/list-minimal-calls"},{"title":"Get Conversation by ID","deprecated":null,"version":null,"sidebarTitle":"Get conversation","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}","href":"/api-reference/endpoint/get-conversation"},{"title":"Terminate Conversation","deprecated":null,"version":null,"sidebarTitle":"Terminate conversation","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}/terminate","href":"/api-reference/endpoint/terminate-conversation"},{"title":"List Calls","deprecated":null,"version":null,"sidebarTitle":"List conversations","openapi":"/api-reference/openapi.json post /v1/voice-agents/conversations/list","href":"/api-reference/endpoint/list-conversations"},{"title":"Download Call Recording","deprecated":null,"version":null,"sidebarTitle":"Download call recording","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}/recording","href":"/api-reference/endpoint/download-call-recording"}]},{"group":"Outbound Campaigns","pages":[{"title":"Create Campaign","deprecated":null,"version":null,"sidebarTitle":"Create campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns","href":"/api-reference/endpoint/create-campaign"},{"title":"List Campaigns","deprecated":null,"version":null,"sidebarTitle":"List campaigns","openapi":"/api-reference/openapi.json get /v1/voice-agents/campaigns","href":"/api-reference/endpoint/list-campaigns"},{"title":"Get Campaign by ID","deprecated":null,"version":null,"sidebarTitle":"Get campaign","openapi":"/api-reference/openapi.json get /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/get-campaign"},{"title":"Update Campaign Name","deprecated":null,"version":null,"sidebarTitle":"Update campaign","openapi":"/api-reference/openapi.json patch /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/update-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"sidebarTitle":"Delete campaign","openapi":"/api-reference/openapi.json delete /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/delete-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"sidebarTitle":"Cancel campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/cancel","href":"/api-reference/endpoint/cancel-campaign"},{"title":"Retry Campaign","deprecated":null,"version":null,"sidebarTitle":"Retry campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/retry","href":"/api-reference/endpoint/retry-campaign"},{"title":"Pause Campaign","deprecated":null,"version":null,"sidebarTitle":"Pause campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/pause","href":"/api-reference/endpoint/pause-campaign"},{"title":"Resume Campaign","deprecated":null,"version":null,"sidebarTitle":"Resume campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/resume","href":"/api-reference/endpoint/resume-campaign"}]},{"group":"Dictionaries","pages":[{"title":"Create Voice Dictionary","deprecated":null,"version":null,"sidebarTitle":"Create voice dictionary","openapi":"/api-reference/openapi.json post /v1/voice-agents/voice-dictionaries","href":"/api-reference/endpoint/create-voice-dictionary"},{"title":"List Voice Dictionaries","deprecated":null,"version":null,"sidebarTitle":"List voice dictionaries","openapi":"/api-reference/openapi.json get /v1/voice-agents/voice-dictionaries/list","href":"/api-reference/endpoint/list-voice-dictionaries"},{"title":"Get Voice Dictionary by ID","deprecated":null,"version":null,"sidebarTitle":"Get voice dictionary","openapi":"/api-reference/openapi.json get /v1/voice-agents/voice-dictionaries/{id}","href":"/api-reference/endpoint/get-voice-dictionary"},{"title":"Update Voice Dictionary","deprecated":null,"version":null,"sidebarTitle":"Update voice dictionary","openapi":"/api-reference/openapi.json patch /v1/voice-agents/voice-dictionaries/{id}","href":"/api-reference/endpoint/update-voice-dictionary"},{"title":"Delete Voice Dictionary","deprecated":null,"version":null,"sidebarTitle":"Delete voice dictionary","openapi":"/api-reference/openapi.json delete /v1/voice-agents/voice-dictionaries/{id}","href":"/api-reference/endpoint/delete-voice-dictionary"},{"title":"Toggle Voice Dictionary Activation","deprecated":null,"version":null,"sidebarTitle":"Toggle voice dictionary activation","openapi":"/api-reference/openapi.json post /v1/voice-agents/voice-dictionaries/toggle-activation","href":"/api-reference/endpoint/toggle-voice-dictionary-activation"},{"title":"Pronounce Text","deprecated":null,"version":null,"sidebarTitle":"Dictionary pronounce","openapi":"/api-reference/openapi.json post /v1/voice-agents/voice-dictionaries/pronounce","href":"/api-reference/endpoint/dictionary-pronounce"},{"title":"List Pronunciation Checks","deprecated":null,"version":null,"sidebarTitle":"List dictionary validations","openapi":"/api-reference/openapi.json get /v1/voice-agents/voice-dictionaries/{id}/validations","href":"/api-reference/endpoint/list-dictionary-validations"},{"title":"Save Pronunciation Check","deprecated":null,"version":null,"sidebarTitle":"Save dictionary validation","openapi":"/api-reference/openapi.json put /v1/voice-agents/voice-dictionaries/{id}/validations","href":"/api-reference/endpoint/save-dictionary-validation"}]},{"group":"Knowledge Base Routes","pages":[{"title":"Create new knowledge base items.","deprecated":null,"version":null,"sidebarTitle":"Create new knowledge base items","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base","href":"/api-reference/create-new-knowledge-base-items"},{"title":"Update a knowledge base item by Id.","deprecated":null,"version":null,"sidebarTitle":"Update a knowledge base item by id","openapi":"/api-reference/openapi.json patch /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/update-a-knowledge-base-item-by-id"},{"title":"Delete Knowledge Base Item","deprecated":null,"version":null,"sidebarTitle":"Delete kb item","openapi":"/api-reference/openapi.json delete /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/endpoint/delete-kb-item"},{"title":"Get Knowledge Base Item by ID","deprecated":null,"version":null,"sidebarTitle":"Get kb item","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/endpoint/get-kb-item"},{"title":"Return a list of Knowledge Base Items.","deprecated":null,"version":null,"sidebarTitle":"Return a list of knowledge base items","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/list","href":"/api-reference/return-a-list-of-knowledge-base-items"},{"title":"Toggle activation of a knowledge base item for a voice agent.","deprecated":null,"version":null,"sidebarTitle":"Toggle activation of a knowledge base item for a voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/toggle-activation","href":"/api-reference/toggle-activation-of-a-knowledge-base-item-for-a-voice-agent"},{"title":"Get Knowledge Base Size Info","deprecated":null,"version":null,"sidebarTitle":"Get kb size info","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/size-info","href":"/api-reference/endpoint/get-kb-size-info"},{"title":"Cancel Knowledge Base Item Processing","deprecated":null,"version":null,"sidebarTitle":"Cancel kb item","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/cancel","href":"/api-reference/endpoint/cancel-kb-item"},{"title":"List Knowledge Base Item Chunks","deprecated":null,"version":null,"sidebarTitle":"List kb item chunks","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/{id}/chunks","href":"/api-reference/endpoint/list-kb-item-chunks"},{"title":"Add Knowledge Base Item Chunk","deprecated":null,"version":null,"sidebarTitle":"Add kb item chunk","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/chunks","href":"/api-reference/endpoint/add-kb-item-chunk"},{"title":"Edit Knowledge Base Item Chunk","deprecated":null,"version":null,"sidebarTitle":"Edit kb item chunk","openapi":"/api-reference/openapi.json patch /v1/voice-agents/knowledge-base/{id}/chunks/{chunkId}","href":"/api-reference/endpoint/edit-kb-item-chunk"},{"title":"Delete Knowledge Base Item Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete kb item chunk","openapi":"/api-reference/openapi.json delete /v1/voice-agents/knowledge-base/{id}/chunks/{chunkId}","href":"/api-reference/endpoint/delete-kb-item-chunk"},{"title":"Batch Edit Knowledge Base Item Chunks","deprecated":null,"version":null,"sidebarTitle":"Batch edit kb item chunks","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/chunks/batch","href":"/api-reference/endpoint/batch-edit-kb-item-chunks"},{"title":"Preview Knowledge Base Item Chunks","deprecated":null,"version":null,"sidebarTitle":"Preview kb item chunks","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/chunks/preview","href":"/api-reference/endpoint/preview-kb-item-chunks"},{"title":"Regenerate Knowledge Base Item Chunks","deprecated":null,"version":null,"sidebarTitle":"Regenerate kb item chunks","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/chunks/regenerate","href":"/api-reference/endpoint/regenerate-kb-item-chunks"},{"title":"Index Knowledge Base Item","deprecated":null,"version":null,"sidebarTitle":"Index kb item","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/index","href":"/api-reference/endpoint/index-kb-item"}]},{"group":"Audio Assets","pages":[{"title":"List Audio Tracks","deprecated":null,"version":null,"sidebarTitle":"List audio assets","openapi":"/api-reference/openapi.json get /v1/voice-agents/audio-assets","href":"/api-reference/endpoint/list-audio-assets"},{"title":"Add Audio Track","deprecated":null,"version":null,"sidebarTitle":"Create audio asset","openapi":"/api-reference/openapi.json post /v1/voice-agents/audio-assets","href":"/api-reference/endpoint/create-audio-asset"},{"title":"Get Audio Track","deprecated":null,"version":null,"sidebarTitle":"Get audio asset","openapi":"/api-reference/openapi.json get /v1/voice-agents/audio-assets/{id}","href":"/api-reference/endpoint/get-audio-asset"},{"title":"Update Audio Track","deprecated":null,"version":null,"sidebarTitle":"Update audio asset","openapi":"/api-reference/openapi.json patch /v1/voice-agents/audio-assets/{id}","href":"/api-reference/endpoint/update-audio-asset"},{"title":"Delete Audio Track","deprecated":null,"version":null,"sidebarTitle":"Delete audio asset","openapi":"/api-reference/openapi.json delete /v1/voice-agents/audio-assets/{id}","href":"/api-reference/endpoint/delete-audio-asset"}]},{"group":"Collections","pages":[{"title":"List Collections","deprecated":null,"version":null,"sidebarTitle":"List collections","openapi":"/api-reference/openapi.json get /v1/voice-agents/collections/list","href":"/api-reference/endpoint/list-collections"},{"title":"Create Collection","deprecated":null,"version":null,"sidebarTitle":"Create collection","openapi":"/api-reference/openapi.json post /v1/voice-agents/collections","href":"/api-reference/endpoint/create-collection"},{"title":"Update Collection","deprecated":null,"version":null,"sidebarTitle":"Update collection","openapi":"/api-reference/openapi.json patch /v1/voice-agents/collections/{id}","href":"/api-reference/endpoint/update-collection"},{"title":"Delete Collection","deprecated":null,"version":null,"sidebarTitle":"Delete collection","openapi":"/api-reference/openapi.json delete /v1/voice-agents/collections/{id}","href":"/api-reference/endpoint/delete-collection"},{"title":"Move Web Tool to Collection","deprecated":null,"version":null,"sidebarTitle":"Move tool to collection","openapi":"/api-reference/openapi.json post /v1/voice-agents/collections/move","href":"/api-reference/endpoint/move-tool-to-collection"}]},{"group":"Web Tools Routes","pages":[{"title":"Get a web tool by ID.","deprecated":null,"version":null,"sidebarTitle":"Get a web tool by id","openapi":"/api-reference/openapi.json get /v1/voice-agents/web-tool/{id}","href":"/api-reference/get-a-web-tool-by-id"},{"title":"Delete a web tool by Id.","deprecated":null,"version":null,"sidebarTitle":"Delete a web tool by id","openapi":"/api-reference/openapi.json delete /v1/voice-agents/web-tool/{id}","href":"/api-reference/delete-a-web-tool-by-id"},{"title":"Toggle activation of a web tool for a voice agent.","deprecated":null,"version":null,"sidebarTitle":"Toggle activation of a web tool for a voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/toggle-activation","href":"/api-reference/toggle-activation-of-a-web-tool-for-a-voice-agent"},{"title":"Test API Tool Configuration","deprecated":null,"version":null,"sidebarTitle":"Test api tool","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/test-api-tool","href":"/api-reference/endpoint/test-api-tool"},{"title":"Create Web Tool","deprecated":null,"version":null,"sidebarTitle":"Create web tool","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool","href":"/api-reference/endpoint/v2/create-web-tool"},{"title":"List Web Tools","deprecated":null,"version":null,"sidebarTitle":"List web tools","openapi":"/api-reference/openapi.json get /v2/voice-agents/web-tool/list","href":"/api-reference/endpoint/v2/list-web-tools"},{"title":"Update Web Tool","deprecated":null,"version":null,"sidebarTitle":"Update web tool","openapi":"/api-reference/openapi.json patch /v2/voice-agents/web-tool/{id}","href":"/api-reference/endpoint/v2/update-web-tool"},{"title":"Check Newer Versions","deprecated":null,"version":null,"sidebarTitle":"Version check web tools","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool/version-check","href":"/api-reference/endpoint/v2/version-check-web-tools"},{"title":"Discover MCP Functions","deprecated":null,"version":null,"sidebarTitle":"Mcp discover","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool/mcp/discover","href":"/api-reference/endpoint/mcp-discover"},{"title":"Test MCP Function","deprecated":null,"version":null,"sidebarTitle":"Mcp test function","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool/mcp/test-function","href":"/api-reference/endpoint/mcp-test-function"}]},{"group":"Secrets","pages":[{"title":"Create Secret","deprecated":null,"version":null,"sidebarTitle":"Create secret","openapi":"/api-reference/openapi.json post /v1/projects/secrets","href":"/api-reference/endpoint/create-secret"},{"title":"List Secrets","deprecated":null,"version":null,"sidebarTitle":"List secrets","openapi":"/api-reference/openapi.json get /v1/projects/secrets/list","href":"/api-reference/endpoint/list-secrets"},{"title":"Update Secret","deprecated":null,"version":null,"sidebarTitle":"Update secret","openapi":"/api-reference/openapi.json patch /v1/projects/secrets/{id}","href":"/api-reference/endpoint/update-secret"},{"title":"Delete Secret","deprecated":null,"version":null,"sidebarTitle":"Delete secret","openapi":"/api-reference/openapi.json delete /v1/projects/secrets/{id}","href":"/api-reference/endpoint/delete-secret"}]},{"group":"Voice Overs","pages":[{"title":"List Voice Over Types","deprecated":null,"version":null,"sidebarTitle":"List voice over types","openapi":"/api-reference/openapi.json get /v2/voice-overs/use-cases/list","href":"/api-reference/endpoint/list-voice-over-types"},{"title":"List Background Music","deprecated":null,"version":null,"sidebarTitle":"List voice over music","openapi":"/api-reference/openapi.json get /v2/voice-overs/backgrounds-music","href":"/api-reference/endpoint/list-voice-over-music"},{"title":"Suggest Voice Overs","deprecated":null,"version":null,"sidebarTitle":"Suggest voice overs","openapi":"/api-reference/openapi.json post /v2/voice-overs","href":"/api-reference/endpoint/suggest-voice-overs"},{"title":"Create Voice Over","deprecated":null,"version":null,"sidebarTitle":"Create voice over","openapi":"/api-reference/openapi.json post /v2/voice-overs/static","href":"/api-reference/endpoint/create-voice-over"},{"title":"List Voice Overs","deprecated":null,"version":null,"sidebarTitle":"List voice overs","openapi":"/api-reference/openapi.json get /v2/voice-overs","href":"/api-reference/endpoint/list-voice-overs"},{"title":"Get Voice Over","deprecated":null,"version":null,"sidebarTitle":"Get voice over","openapi":"/api-reference/openapi.json get /v2/voice-overs/{id}","href":"/api-reference/endpoint/get-voice-over"},{"title":"Approve Voice Over","deprecated":null,"version":null,"sidebarTitle":"Approve voice over","openapi":"/api-reference/openapi.json patch /v2/voice-overs/{id}/approve","href":"/api-reference/endpoint/approve-voice-over"},{"title":"Delete Voice Over","deprecated":null,"version":null,"sidebarTitle":"Delete voice over","openapi":"/api-reference/openapi.json delete /v2/voice-overs/{id}","href":"/api-reference/endpoint/delete-voice-over"},{"title":"Create Voice Over Video","deprecated":null,"version":null,"sidebarTitle":"Create voice over video","openapi":"/api-reference/openapi.json post /v2/voice-overs/{id}/videos","href":"/api-reference/endpoint/create-voice-over-video"},{"title":"Retry Voice Over Video","deprecated":null,"version":null,"sidebarTitle":"Retry voice over video","openapi":"/api-reference/openapi.json post /v2/voice-overs/videos/retry","href":"/api-reference/endpoint/retry-voice-over-video"}]},{"group":"AI Docs Routes","pages":[{"title":"Get AI Content Route","deprecated":null,"version":null,"sidebarTitle":"Get ai content","openapi":"/api-reference/openapi.json get /v1/jobs/ai-content","href":"/api-reference/endpoint/get-ai-content"},{"title":"Get AI Content Cost Estimate Route","deprecated":null,"version":null,"sidebarTitle":"Ai content estimate","openapi":"/api-reference/openapi.json get /v1/jobs/ai-content/estimate","href":"/api-reference/endpoint/ai-content-estimate"},{"title":"Generate AI Content","deprecated":null,"version":null,"sidebarTitle":"Generate transcription ai content v2","openapi":"/api-reference/openapi.json post /v2/jobs/generate-transcription-ai-content","href":"/api-reference/endpoint/generate-transcription-ai-content-v2"}]},{"group":"Jobs Routes","pages":[{"title":"Get Jobs List","deprecated":null,"version":null,"sidebarTitle":"Get jobs list","openapi":"/api-reference/openapi.json post /v1/jobs/all","href":"/api-reference/endpoint/get-jobs-list"},{"title":"Get Job Details By Id","deprecated":null,"version":null,"sidebarTitle":"Get job by id","openapi":"/api-reference/openapi.json get /v1/jobs","href":"/api-reference/endpoint/get-job-by-id"},{"title":"List Jobs","deprecated":null,"version":null,"sidebarTitle":"List jobs v2","openapi":"/api-reference/openapi.json get /v2/jobs","href":"/api-reference/endpoint/list-jobs-v2"},{"title":"Get Single Job","deprecated":null,"version":null,"sidebarTitle":"Get job v2","openapi":"/api-reference/openapi.json get /v2/jobs/view/{id}","href":"/api-reference/endpoint/get-job-v2"},{"title":"Update Job Title","deprecated":null,"version":null,"sidebarTitle":"Update job title v2","openapi":"/api-reference/openapi.json patch /v2/jobs/{id}","href":"/api-reference/endpoint/update-job-title-v2"},{"title":"Delete Job","deprecated":null,"version":null,"sidebarTitle":"Delete job v2","openapi":"/api-reference/openapi.json delete /v2/jobs/{id}","href":"/api-reference/endpoint/delete-job-v2"}]},{"group":"Project Routes","pages":[{"title":"Get Project By API Key","deprecated":null,"version":null,"sidebarTitle":"Get project by api key","openapi":"/api-reference/openapi.json get /v1/projects/by-api-key","href":"/api-reference/endpoint/get-project-by-api-key"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"sidebarTitle":"List api keys","openapi":"/api-reference/openapi.json get /v1/projects/api-keys","href":"/api-reference/endpoint/list-api-keys"},{"title":"Create API Key","deprecated":null,"version":null,"sidebarTitle":"Create api key","openapi":"/api-reference/openapi.json post /v1/projects/api-keys","href":"/api-reference/endpoint/create-api-key"},{"title":"Update API Key","deprecated":null,"version":null,"sidebarTitle":"Update api key","openapi":"/api-reference/openapi.json patch /v1/projects/api-keys","href":"/api-reference/endpoint/update-api-key"},{"title":"Revoke API Key","deprecated":null,"version":null,"sidebarTitle":"Revoke api key","openapi":"/api-reference/openapi.json delete /v1/projects/api-keys","href":"/api-reference/endpoint/revoke-api-key"},{"title":"Rotate API Key","deprecated":null,"version":null,"sidebarTitle":"Rotate api key","openapi":"/api-reference/openapi.json post /v1/projects/api-keys/{apiKeyId}/rotate","href":"/api-reference/endpoint/rotate-api-key"},{"title":"Stop Previous API Key Value","deprecated":null,"version":null,"sidebarTitle":"Stop previous api key value","openapi":"/api-reference/openapi.json delete /v1/projects/api-keys/{apiKeyId}/previous","href":"/api-reference/endpoint/stop-previous-api-key-value"},{"title":"Disable API Key","deprecated":null,"version":null,"sidebarTitle":"Disable api key","openapi":"/api-reference/openapi.json post /v1/projects/api-keys/{apiKeyId}/disable","href":"/api-reference/endpoint/disable-api-key"},{"title":"Enable API Key","deprecated":null,"version":null,"sidebarTitle":"Enable api key","openapi":"/api-reference/openapi.json post /v1/projects/api-keys/{apiKeyId}/enable","href":"/api-reference/endpoint/enable-api-key"},{"title":"List Grantable API Key Scopes","deprecated":null,"version":null,"sidebarTitle":"List api key scopes","openapi":"/api-reference/openapi.json get /v1/projects/api-keys/scopes-schema","href":"/api-reference/endpoint/list-api-key-scopes"},{"title":"List API Key Scope Presets","deprecated":null,"version":null,"sidebarTitle":"List api key scope presets","openapi":"/api-reference/openapi.json get /v1/projects/api-keys/scope-presets","href":"/api-reference/endpoint/list-api-key-scope-presets"}]},{"group":"Agents Analytics and Performance Metrics","pages":[{"title":"Get Overview Analytics","deprecated":null,"version":null,"sidebarTitle":"Get overview analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/overview","href":"/api-reference/endpoint/get-overview-analytics"},{"title":"Get Performance Analytics","deprecated":null,"version":null,"sidebarTitle":"Get performance analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/performance","href":"/api-reference/endpoint/get-performance-analytics"},{"title":"Get Satisfaction and Outcome Analytics","description":"Satisfaction and outcome scores of finished calls (`COMPLETED` and `FORWARDED`) in the period. Each call is counted once, as its latest analytics record says. Calls are in range by when they started. After each call an AI model reads the transcript and scores it; nobody surveys the caller. Calls the model couldn't score are left out of the score they lack, so each figure has its own sample.","deprecated":null,"version":null,"sidebarTitle":"Get satisfaction analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/satisfaction","href":"/api-reference/endpoint/get-satisfaction-analytics"},{"title":"Call Figures by Agent","deprecated":null,"version":null,"sidebarTitle":"Analytics overview by agent","openapi":"/api-reference/openapi.json get /v1/agent-analytics/overview/by-agent","href":"/api-reference/endpoint/analytics-overview-by-agent"}]},{"group":"Exporting Conversations","pages":[{"title":"Export Conversations","description":"Starts an export of the calls that match the filters to an Excel (XLSX) file. The file is built in the background: the request returns `202` at once with an `exportId`, and the file is emailed (plus an in-app notification) to the user behind the request, which for an API key is the key's owner. The download link is valid for 24 hours.\n\nOne row per call (each call once, as its latest analytics record says), with the columns Time, Agent, Status, Duration (seconds), Channel, ID, User Number, Agent Number, Agent ID, Agent Type, Forwarded To Human, Resolved, Sentiment, Processing Time (ms), Has Errors, ASR Error, LLM Error, TTS Error, Knowledge Gap Type and Out Of Scope Requests, then one `Outcome: \u003cfield>` column per outcome field and one `Outcome Default Param: \u003cname>` column per default parameter found in the exported calls.\n\nAn export holds up to 1,000 calls: more returns `400` (\"Export limit exceeded ... Please narrow your date range\"). A scoped API key needs the `call_history:export` scope (no preset includes it); a root key can export.","deprecated":null,"version":null,"sidebarTitle":"Export conversations","openapi":"/api-reference/openapi.json get /v1/agent-analytics/conversations/export","href":"/api-reference/endpoint/export-conversations"},{"title":"Check Export Status","deprecated":null,"version":null,"sidebarTitle":"Export conversations status","openapi":"/api-reference/openapi.json get /v1/agent-analytics/conversations/export/status","href":"/api-reference/endpoint/export-conversations-status"}]},{"group":"Call Logs","pages":[{"title":"Get Call Log by ID","deprecated":null,"version":null,"sidebarTitle":"Get call log","openapi":"/api-reference/openapi.json get /v1/agent-analytics/logs/{id}","href":"/api-reference/endpoint/get-call-log"},{"title":"List Call Logs","deprecated":null,"version":null,"sidebarTitle":"List call logs","openapi":"/api-reference/openapi.json get /v1/agent-analytics/logs","href":"/api-reference/endpoint/list-call-logs"}]},{"group":"Deprecated APIs","pages":[{"group":"Voice Agents","expanded":true,"pages":[{"title":"Create Voice Agent Route","deprecated":true,"version":null,"sidebarTitle":"Create voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents","href":"/api-reference/endpoint/create-voice-agent"},{"title":"Update Voice Agent Route","deprecated":true,"version":null,"sidebarTitle":"Update voice agent","openapi":"/api-reference/openapi.json patch /v1/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/update-voice-agent"},{"title":"Get Voice Agents List Route","deprecated":true,"version":null,"sidebarTitle":"Get all voice agents","openapi":"/api-reference/openapi.json get /v1/voice-agents","href":"/api-reference/endpoint/get-all-voice-agents"},{"title":"Get A Voice Agent By Id Route","deprecated":true,"version":null,"sidebarTitle":"Get voice agent by id","openapi":"/api-reference/openapi.json get /v1/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/get-voice-agent-by-id"}]},{"group":"Voice Agents Conversations Routes","expanded":true,"pages":[{"title":"Start a Call for a Conversation Route","deprecated":true,"version":null,"sidebarTitle":"Start a call","openapi":"/api-reference/openapi.json post /v1/voice-agents/call","href":"/api-reference/endpoint/start-a-call"}]},{"group":"Web Tools Routes","expanded":true,"pages":[{"title":"Create a new web tool.","deprecated":true,"version":null,"sidebarTitle":"Create a new web tool","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool","href":"/api-reference/create-a-new-web-tool"},{"title":"Update a web tool by Id.","deprecated":true,"version":null,"sidebarTitle":"Update a web tool by id","openapi":"/api-reference/openapi.json patch /v1/voice-agents/web-tool/{id}","href":"/api-reference/update-a-web-tool-by-id"},{"title":"Return a list of Web Tools.","deprecated":true,"version":null,"sidebarTitle":"Return a list of web tools","openapi":"/api-reference/openapi.json get /v1/voice-agents/web-tool/list","href":"/api-reference/return-a-list-of-web-tools"},{"title":"Check Web Tool Version Updates","deprecated":true,"version":null,"sidebarTitle":"Version check","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/version-check","href":"/api-reference/endpoint/version-check"}]}]}]},{"tab":"WebSocket API","icon":"rocket-vertical","pages":[{"title":"WebSocket API","href":"/websocket/websocket-api"}]},{"tab":"Changelog","icon":"rectangle-history-circle-user","pages":[{"title":"Changelog","href":"/changelog/main"}]}]},"basePath":"","title":"Call Figures by Agent - Hamsa API","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}