Volume health for an inbox against its own baseline
Compares the requested window’s message volume against this inbox’s own
recent norm and scores the deviation, for health/risk surfaces.
The baseline is a trailing average of the baselinePeriods windows of the
same length immediately before dateFrom (default 3). No seasonal
adjustment is applied. dateFrom and dateTo are both required; the window
plus its baseline must stay within a 400-day scan, so long ranges need a
lower baselinePeriods.
severityScore (0–100) tracks the size of a decline — growth scores 0
with label none. Bands: critical 75+, high 50–74, moderate 25–49,
low 1–24.
trend compares the two halves of the requested window, which is what
separates “down and still falling” from “down but recovering”.
Insufficient history is reported explicitly. With no baseline volume,
volumeVsBaselinePct and severityScore are null and severityLabel is
insufficient_history — a silent -100% would be indistinguishable from a
real collapse and would drive alerts the data can’t justify.
GET
/
api
/
inboxes
/
{channelId}
/
health
Volume health for an inbox against its own baseline
curl --request GET \ --url https://core-api.getaptly.com/api/inboxes/{channelId}/health \ --header 'x-token: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aptly API","colors":{"primary":"#0066FF"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aptly-10a57313","hasAudioNarration":false,"actualSubdomain":"aptly-10a57313","customDomains":["docs.getaptly.com"],"gitSource":{"type":"github","owner":"workturbo","repo":"core-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab","collectionId":"1788173d-2862-4418-873a-da2b64e83176","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab"},"feedback":{"agentFeedback":true},"entitlements":{},"buildId":"6ae4dfc987cb31e1fa2cb0ab","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":192},{"language":"default","tag":"Board","count":28},{"language":"default","tag":"Documentation","count":17},{"language":"default","tag":"Aptly Portal","count":14},{"language":"default","tag":"Contacts","count":10},{"language":"default","tag":"Cards","count":9},{"language":"default","tag":"Knowledge","count":8},{"language":"default","tag":"Getting Started","count":7},{"language":"default","tag":"Inboxes","count":7},{"language":"default","tag":"Context \u0026 Locations","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline","slug":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline","pageMetadata":{"title":"Volume health for an inbox against its own baseline","description":"Compares the requested window's message volume against this inbox's own\nrecent norm and scores the deviation, for health/risk surfaces.\n\nThe baseline is a trailing average of the `baselinePeriods` windows of the\nsame length immediately before `dateFrom` (default 3). No seasonal\nadjustment is applied. `dateFrom` and `dateTo` are both required; the window\nplus its baseline must stay within a 400-day scan, so long ranges need a\nlower `baselinePeriods`.\n\n`severityScore` (0–100) tracks the size of a **decline** — growth scores 0\nwith label `none`. Bands: `critical` 75+, `high` 50–74, `moderate` 25–49,\n`low` 1–24.\n\n`trend` compares the two halves of the requested window, which is what\nseparates \"down and still falling\" from \"down but recovering\".\n\n**Insufficient history is reported explicitly.** With no baseline volume,\n`volumeVsBaselinePct` and `severityScore` are `null` and `severityLabel` is\n`insufficient_history` — a silent `-100%` would be indistinguishable from a\nreal collapse and would drive alerts the data can't justify.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/health","href":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline","autogeneratedByOpenApi":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 p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Compares the requested window’s message volume against this inbox’s own\\nrecent norm and scores the deviation, for health/risk surfaces.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The baseline is a trailing average of the \", _jsx(_components.code, {\n children: \"baselinePeriods\"\n }), \" windows of the\\nsame length immediately before \", _jsx(_components.code, {\n children: \"dateFrom\"\n }), \" (default 3). No seasonal\\nadjustment is applied. \", _jsx(_components.code, {\n children: \"dateFrom\"\n }), \" and \", _jsx(_components.code, {\n children: \"dateTo\"\n }), \" are both required; the window\\nplus its baseline must stay within a 400-day scan, so long ranges need a\\nlower \", _jsx(_components.code, {\n children: \"baselinePeriods\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"severityScore\"\n }), \" (0–100) tracks the size of a \", _jsx(_components.strong, {\n children: \"decline\"\n }), \" — growth scores 0\\nwith label \", _jsx(_components.code, {\n children: \"none\"\n }), \". Bands: \", _jsx(_components.code, {\n children: \"critical\"\n }), \" 75+, \", _jsx(_components.code, {\n children: \"high\"\n }), \" 50–74, \", _jsx(_components.code, {\n children: \"moderate\"\n }), \" 25–49,\\n\", _jsx(_components.code, {\n children: \"low\"\n }), \" 1–24.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"trend\"\n }), \" compares the two halves of the requested window, which is what\\nseparates “down and still falling” from “down but recovering”.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Insufficient history is reported explicitly.\"\n }), \" With no baseline volume,\\n\", _jsx(_components.code, {\n children: \"volumeVsBaselinePct\"\n }), \" and \", _jsx(_components.code, {\n children: \"severityScore\"\n }), \" are \", _jsx(_components.code, {\n children: \"null\"\n }), \" and \", _jsx(_components.code, {\n children: \"severityLabel\"\n }), \" is\\n\", _jsx(_components.code, {\n children: \"insufficient_history\"\n }), \" — a silent \", _jsx(_components.code, {\n children: \"-100%\"\n }), \" would be indistinguishable from a\\nreal collapse and would drive alerts the data can’t justify.\"]\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":"Volume health for an inbox against its own baseline","description":"Compares the requested window's message volume against this inbox's own\nrecent norm and scores the deviation, for health/risk surfaces.\n\nThe baseline is a trailing average of the `baselinePeriods` windows of the\nsame length immediately before `dateFrom` (default 3). No seasonal\nadjustment is applied. `dateFrom` and `dateTo` are both required; the window\nplus its baseline must stay within a 400-day scan, so long ranges need a\nlower `baselinePeriods`.\n\n`severityScore` (0–100) tracks the size of a **decline** — growth scores 0\nwith label `none`. Bands: `critical` 75+, `high` 50–74, `moderate` 25–49,\n`low` 1–24.\n\n`trend` compares the two halves of the requested window, which is what\nseparates \"down and still falling\" from \"down but recovering\".\n\n**Insufficient history is reported explicitly.** With no baseline volume,\n`volumeVsBaselinePct` and `severityScore` are `null` and `severityLabel` is\n`insufficient_history` — a silent `-100%` would be indistinguishable from a\nreal collapse and would drive alerts the data can't justify.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/health","href":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Volume health for an inbox against its own baseline","description":"Compares the requested window's message volume against this inbox's own\nrecent norm and scores the deviation, for health/risk surfaces.\n\nThe baseline is a trailing average of the `baselinePeriods` windows of the\nsame length immediately before `dateFrom` (default 3). No seasonal\nadjustment is applied. `dateFrom` and `dateTo` are both required; the window\nplus its baseline must stay within a 400-day scan, so long ranges need a\nlower `baselinePeriods`.\n\n`severityScore` (0–100) tracks the size of a **decline** — growth scores 0\nwith label `none`. Bands: `critical` 75+, `high` 50–74, `moderate` 25–49,\n`low` 1–24.\n\n`trend` compares the two halves of the requested window, which is what\nseparates \"down and still falling\" from \"down but recovering\".\n\n**Insufficient history is reported explicitly.** With no baseline volume,\n`volumeVsBaselinePct` and `severityScore` are `null` and `severityLabel` is\n`insufficient_history` — a silent `-100%` would be indistinguishable from a\nreal collapse and would drive alerts the data can't justify.\n","operationId":"getInboxHealth","tags":["Inboxes"],"security":["b9089b2d-3318-435f-82dd-701162fd7cd7","545ab34c-0026-408b-a985-78c05a168219","60c70002-35ce-48f0-8b3d-632a390f7076"],"parameters":["dedb0319-e0c0-4c0e-9927-876c8ffcaccc","4ad6c722-f446-493e-98ed-8c42fa30dea9","fe2e33d2-0e2e-4652-abf2-98836c85cc03","4ec9dd90-476c-475f-b7dc-b0797f4a69d8","cfc60b07-9380-4b49-97f2-d82b565afcac"],"responses":{"200":"fc545f8e-719c-49ae-8a86-2354b30823eb","400":"42c7a6df-e74b-4ede-ae47-0dee81000a2c","401":"d937aab6-cffc-4256-b267-89ff6780f490","403":"29d3e0bf-1ffe-46fd-99c6-5c6b9bcd544b","404":"dd5bf1b8-2163-4450-940e-66cf692d2c19"},"method":"get","type":"path","servers":["07b42306-8584-4b68-93b8-f52adbaae2fe"],"path":"/api/inboxes/{channelId}/health","baseUrlOptions":["https://core-api.getaptly.com"],"title":"Volume health for an inbox against its own baseline","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dedb0319-e0c0-4c0e-9927-876c8ffcaccc":{"name":"channelId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"External channel meta ID (`meta.id`) of the inbox.","uniqueKey":"","typeLabel":"string"},"description":"External channel meta ID (`meta.id`) of the inbox."},"4ad6c722-f446-493e-98ed-8c42fa30dea9":{"name":"dateFrom","in":"query","required":true,"schema":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"fe2e33d2-0e2e-4652-abf2-98836c85cc03":{"name":"dateTo","in":"query","required":true,"schema":{"type":"string","format":"date-time","isRequired":true,"description":"Exclusive.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Exclusive."},"4ec9dd90-476c-475f-b7dc-b0797f4a69d8":{"name":"baselinePeriods","in":"query","schema":{"type":"integer","default":3,"minimum":1,"maximum":12,"description":"How many same-length windows before `dateFrom` are averaged into the baseline.","uniqueKey":"","typeLabel":"integer"},"description":"How many same-length windows before `dateFrom` are averaged into the baseline."},"cfc60b07-9380-4b49-97f2-d82b565afcac":{"name":"includeJunk","in":"query","schema":{"type":"boolean","default":false,"uniqueKey":"","typeLabel":"boolean"}}},"responses":{"fc545f8e-719c-49ae-8a86-2354b30823eb":{"description":"Volume health for the window.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"window":{"type":"object","properties":{"from":{"type":"string","format":"date-time","uniqueKey":"data.window.from","typeLabel":"string\u003cdate-time>"},"to":{"type":"string","format":"date-time","uniqueKey":"data.window.to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.window","typeLabel":"object"},"baseline":{"type":"object","properties":{"from":{"type":"string","format":"date-time","uniqueKey":"data.baseline.from","typeLabel":"string\u003cdate-time>"},"to":{"type":"string","format":"date-time","uniqueKey":"data.baseline.to","typeLabel":"string\u003cdate-time>"},"periods":{"type":"integer","uniqueKey":"data.baseline.periods","typeLabel":"integer"},"avgVolume":{"oneOf":[{"type":"number","description":"Mean volume per period across the baseline span.","uniqueKey":"data.baseline.avgVolume.oneOf.0","typeLabel":"number"},{"type":"null","description":"Mean volume per period across the baseline span.","uniqueKey":"data.baseline.avgVolume.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.baseline.avgVolume","typeLabel":"number | null"},"sufficient":{"type":"boolean","description":"False when the baseline span carried no volume. Everything derived from the baseline is null in that case.","uniqueKey":"data.baseline.sufficient","typeLabel":"boolean"}},"uniqueKey":"data.baseline","typeLabel":"object"},"volume":{"type":"integer","description":"Messages in the requested window.","uniqueKey":"data.volume","typeLabel":"integer"},"volumeVsBaselinePct":{"oneOf":[{"type":"number","description":"Percentage change against the baseline average. Negative is a decline. Null when `baseline.sufficient` is false.","uniqueKey":"data.volumeVsBaselinePct.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percentage change against the baseline average. Negative is a decline. Null when `baseline.sufficient` is false.","uniqueKey":"data.volumeVsBaselinePct.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.volumeVsBaselinePct","typeLabel":"number | null"},"trend":{"type":"string","enum":["falling","rising","flat","unknown"],"description":"Second half of the window vs. the first. `unknown` when the window is too short to split.","uniqueKey":"data.trend","typeLabel":"enum\u003cstring>"},"severityScore":{"oneOf":[{"type":"integer","description":"0–100, tracking decline magnitude. 0 for flat or growing volume.","uniqueKey":"data.severityScore.oneOf.0","typeLabel":"integer"},{"type":"null","description":"0–100, tracking decline magnitude. 0 for flat or growing volume.","uniqueKey":"data.severityScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.severityScore","typeLabel":"integer | null"},"severityLabel":{"type":"string","enum":["critical","high","moderate","low","none","insufficient_history"],"uniqueKey":"data.severityLabel","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"data.tags.items.[INDEX]","typeLabel":"string"},"description":"Human-readable flags, e.g. `Usage down`, `No activity`, `Still falling`.","uniqueKey":"data.tags","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"window":{"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z"},"baseline":{"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z","periods":123,"avgVolume":123,"sufficient":true},"volume":123,"volumeVsBaselinePct":123,"trend":"falling","severityScore":123,"severityLabel":"critical","tags":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"42c7a6df-e74b-4ede-ae47-0dee81000a2c":{"description":"Missing window, invalid `baselinePeriods`, or a window plus baseline exceeding the 400-day scan limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d937aab6-cffc-4256-b267-89ff6780f490":{"description":"Invalid or missing credential.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"29d3e0bf-1ffe-46fd-99c6-5c6b9bcd544b":{"description":"The authenticated user cannot reach this inbox.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"dd5bf1b8-2163-4450-940e-66cf692d2c19":{"description":"Inbox not found in your company.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"b9089b2d-3318-435f-82dd-701162fd7cd7":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"}},"545ab34c-0026-408b-a985-78c05a168219":{"DelegateToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"}},"60c70002-35ce-48f0-8b3d-632a390f7076":{"PartnerBearer":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"}}},"servers":{"07b42306-8584-4b68-93b8-f52adbaae2fe":{"url":"https://core-api.getaptly.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"},"schema":{"title":"x-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyHeader","name":"x-token"}],"title":"ApiKeyHeader"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"},"schema":{"title":"Authorization","type":"string","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"DelegateToken","name":"Authorization"}],"title":"DelegateToken"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerBearer","name":"Authorization"}],"title":"PartnerBearer"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"aptly-10a57313","siteName":"Aptly API","title":"Volume health for an inbox against its own baseline - Aptly API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T18:20:14.119Z","originalFileLocation":"api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline.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=\"Compares the requested window\u0026#x27;s message volume against this inbox\u0026#x27;s own recent norm and scores the deviation, for health/risk surfaces. The baseline is a trailing average of the baselinePeriods windows of the same length immediately before dateFrom (default 3). No seasonal adjustment is applied. dateFrom and dateTo are both required; the window plus its baseline must stay within a 400-day scan, so long ranges need a lower baselinePeriods. severityScore (0–100) tracks the size of a decline — growth scores 0 with label none. Bands: critical 75+, high 50–74, moderate 25–49, low 1–24. trend compares the two halves of the requested window, which is what separates \u0026quot;down and still falling\u0026quot; from \u0026quot;down but recovering\u0026quot;. Insufficient history is reported explicitly. With no baseline volume, volumeVsBaselinePct and severityScore are null and severityLabel is insufficient_history — a silent -100% would be indistinguishable from a real collapse and would drive alerts the data can\u0026#x27;t justify.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Volume health for an inbox against its own baseline - Aptly API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Compares the requested window\u0026#x27;s message volume against this inbox\u0026#x27;s own recent norm and scores the deviation, for health/risk surfaces. The baseline is a trailing average of the baselinePeriods windows of the same length immediately before dateFrom (default 3). No seasonal adjustment is applied. dateFrom and dateTo are both required; the window plus its baseline must stay within a 400-day scan, so long ranges need a lower baselinePeriods. severityScore (0–100) tracks the size of a decline — growth scores 0 with label none. Bands: critical 75+, high 50–74, moderate 25–49, low 1–24. trend compares the two halves of the requested window, which is what separates \u0026quot;down and still falling\u0026quot; from \u0026quot;down but recovering\u0026quot;. Insufficient history is reported explicitly. With no baseline volume, volumeVsBaselinePct and severityScore are null and severityLabel is insufficient_history — a silent -100% would be indistinguishable from a real collapse and would drive alerts the data can\u0026#x27;t justify.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aptly API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aptly-10a57313.mintlify.app/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Volume+health+for+an+inbox+against+its+own+baseline\u0026amp;description=Compares+the+requested+window%27s+message+volume+against+this+inbox%27s+own%0Arecent+norm+and+scores+the+deviation%2C+for+health%2Frisk+surfaces.%0A%0AThe+baseline+is+a+trail\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=f95485f7f1ad6fcb802a0d8dfd9f1cabefe6163f361ba1374bbb06a6911fbf62\">\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=\"Volume health for an inbox against its own baseline - Aptly API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Compares the requested window\u0026#x27;s message volume against this inbox\u0026#x27;s own recent norm and scores the deviation, for health/risk surfaces. The baseline is a trailing average of the baselinePeriods windows of the same length immediately before dateFrom (default 3). No seasonal adjustment is applied. dateFrom and dateTo are both required; the window plus its baseline must stay within a 400-day scan, so long ranges need a lower baselinePeriods. severityScore (0–100) tracks the size of a decline — growth scores 0 with label none. Bands: critical 75+, high 50–74, moderate 25–49, low 1–24. trend compares the two halves of the requested window, which is what separates \u0026quot;down and still falling\u0026quot; from \u0026quot;down but recovering\u0026quot;. Insufficient history is reported explicitly. With no baseline volume, volumeVsBaselinePct and severityScore are null and severityLabel is insufficient_history — a silent -100% would be indistinguishable from a real collapse and would drive alerts the data can\u0026#x27;t justify.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aptly-10a57313.mintlify.app/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Volume+health+for+an+inbox+against+its+own+baseline\u0026amp;description=Compares+the+requested+window%27s+message+volume+against+this+inbox%27s+own%0Arecent+norm+and+scores+the+deviation%2C+for+health%2Frisk+surfaces.%0A%0AThe+baseline+is+a+trail\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=f95485f7f1ad6fcb802a0d8dfd9f1cabefe6163f361ba1374bbb06a6911fbf62\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getaptly.com/#organization\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getaptly.com#website\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline#webpage\",\"url\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline\",\"name\":\"Volume health for an inbox against its own baseline\",\"description\":\"Compares the requested window's message volume against this inbox's own recent norm and scores the deviation, for health/risk surfaces. The baseline is a trailing average of the baselinePeriods windows of the same length immediately before dateFrom (default 3). No seasonal adjustment is applied. dateFrom and dateTo are both required; the window plus its baseline must stay within a 400-day scan, so long ranges need a lower baselinePeriods. severityScore (0–100) tracks the size of a decline — growth scores 0 with label none. Bands: critical 75+, high 50–74, moderate 25–49, low 1–24. trend compares the two halves of the requested window, which is what separates \\\"down and still falling\\\" from \\\"down but recovering\\\". Insufficient history is reported explicitly. With no baseline volume, volumeVsBaselinePct and severityScore are null and severityLabel is insufficient_history — a silent -100% would be indistinguishable from a real collapse and would drive alerts the data can't justify.\",\"dateModified\":\"2026-10-30T18:20:14.119Z\",\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.getaptly.com/api-reference/users/list-users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inboxes\",\"item\":\"https://docs.getaptly.com/api-reference/inboxes/list-inboxes-you-can-query\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Volume health for an inbox against its own baseline\",\"item\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline#apireference\",\"headline\":\"Volume health for an inbox against its own baseline\",\"name\":\"Volume health for an inbox against its own baseline\",\"description\":\"Compares the requested window's message volume against this inbox's own recent norm and scores the deviation, for health/risk surfaces. The baseline is a trailing average of the baselinePeriods windows of the same length immediately before dateFrom (default 3). No seasonal adjustment is applied. dateFrom and dateTo are both required; the window plus its baseline must stay within a 400-day scan, so long ranges need a lower baselinePeriods. severityScore (0–100) tracks the size of a decline — growth scores 0 with label none. Bands: critical 75+, high 50–74, moderate 25–49, low 1–24. trend compares the two halves of the requested window, which is what separates \\\"down and still falling\\\" from \\\"down but recovering\\\". Insufficient history is reported explicitly. With no baseline volume, volumeVsBaselinePct and severityScore are null and severityLabel is insufficient_history — a silent -100% would be indistinguishable from a real collapse and would drive alerts the data can't justify.\",\"url\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline#webpage\"},\"dateModified\":\"2026-10-30T18:20:14.119Z\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aptly API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aptly API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users","href":"/api-reference/users/list-users"},{"title":"List a user's email inboxes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users/{userId}/inboxes","href":"/api-reference/users/list-a-users-email-inboxes"}]},{"group":"Inboxes","pages":[{"title":"List inboxes you can query","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes","href":"/api-reference/inboxes/list-inboxes-you-can-query"},{"title":"List threads and messages on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/messages","href":"/api-reference/inboxes/list-threads-and-messages-on-an-inbox"},{"title":"Conversation analytics for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/analytics","href":"/api-reference/inboxes/conversation-analytics-for-an-inbox"},{"title":"Activity history for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/history","href":"/api-reference/inboxes/activity-history-for-an-inbox"},{"title":"Volume and response-time trends for an inbox","description":"A gap-free time series for one inbox, rolled up server-side by day, week,\nmonth or quarter. Both `dateFrom` and `dateTo` are required (max 400 days);\n`dateTo` is exclusive. Periods with no activity are returned with zero volume\nrather than omitted, so the series can be charted directly.\n\nAll bucketing is UTC. Weeks start Monday (ISO) and are keyed by that Monday's\ndate, so week keys sort alongside day keys.\n\n**Two bucketing bases, deliberately:** `volume` counts messages sent or\nreceived *during* the period, while `threadCount` and the response/rate\nfigures describe threads whose *last activity* fell in the period. Response\ntimes carry no per-message timestamps, so they can't be attributed to a\nsingle day of a long-running thread. Do not divide `volume` by `threadCount`.\n\nAverages are combined from underlying sums and counts, so a quiet day never\ncarries the same weight as a busy one. `responseCount` is the number of\nreplies behind `avgResponseHrs`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/trends","href":"/api-reference/inboxes/volume-and-response-time-trends-for-an-inbox"},{"title":"Volume health for an inbox against its own baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/health","href":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline"},{"title":"List unsent drafts on an inbox","description":"Returns the unsent drafts on the given email inbox. The inbox is identified\nby its `channelId` — the same value returned as `channelId` from\n`GET /api/users/{userId}/inboxes`.\n\nEach item in the response is a draft entry with the parent discussion's\n`streamId` attached. Drafts currently in the process of sending (after\n`POST /api/email/send` was called and before the upstream provider accepts\nthe message) are excluded.\n\nWith API-key auth the only scope check is that the inbox belongs to your\ncompany. With delegate-token auth (`inboxes:*` scope) the inbox must also be\none the authenticated user can reach personally or via a team membership.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/drafts","href":"/api-reference/inboxes/list-unsent-drafts-on-an-inbox"}]},{"group":"Schema","pages":[{"title":"Get board schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/schema/{boardId}","href":"/api-reference/schema/get-board-schema"}]},{"group":"Boards","pages":[{"title":"List boards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/boards","href":"/api-reference/boards/list-boards"},{"title":"Create a board","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/boards","href":"/api-reference/boards/create-a-board"}]},{"group":"Cards","pages":[{"title":"List cards","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/list","href":"/api-reference/cards/list-cards"},{"title":"List cards (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}","href":"/api-reference/cards/list-cards-deprecated"},{"title":"Create or update a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}","href":"/api-reference/cards/create-or-update-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}","href":"/api-reference/cards/get-a-card"},{"title":"Archive a card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/{cardId}","href":"/api-reference/cards/archive-a-card"},{"title":"List comments on a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/comments","href":"/api-reference/cards/list-comments-on-a-card"},{"title":"List contacts linked to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/contacts","href":"/api-reference/cards/list-contacts-linked-to-a-card"},{"title":"Add or update a comment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/comment","href":"/api-reference/cards/add-or-update-a-comment"},{"title":"Upload a file to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/file","href":"/api-reference/cards/upload-a-file-to-a-card"}]},{"group":"Board","pages":[{"title":"Archive a board","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}","href":"/api-reference/board/archive-a-board"},{"title":"List merge fields for a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/merge-fields","href":"/api-reference/board/list-merge-fields-for-a-board"},{"title":"List users who can open a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/users","href":"/api-reference/board/list-users-who-can-open-a-board"},{"title":"Add a tab view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/tabViews","href":"/api-reference/board/add-a-tab-view"},{"title":"Add a tab view (legacy)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/tabView","href":"/api-reference/board/add-a-tab-view-legacy"},{"title":"Verify a delegate token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/verify-user","href":"/api-reference/board/verify-a-delegate-token"},{"title":"Set or update the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/webhook","href":"/api-reference/board/set-or-update-the-boards-webhook"},{"title":"Remove the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/webhook","href":"/api-reference/board/remove-the-boards-webhook"},{"title":"Get full board configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration","href":"/api-reference/board/get-full-board-configuration"},{"title":"List board automations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/automations","href":"/api-reference/board/list-board-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/automations","href":"/api-reference/board/create-an-automation"},{"title":"List create-card rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/card-rules","href":"/api-reference/board/list-create-card-rules"},{"title":"Get board options","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/options","href":"/api-reference/board/get-board-options"},{"title":"List board fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/fields","href":"/api-reference/board/list-board-fields"},{"title":"Add a field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/fields","href":"/api-reference/board/add-a-field"},{"title":"Add a mirror field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/mirror-fields","href":"/api-reference/board/add-a-mirror-field"},{"title":"Update a field","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/delete-a-field"},{"title":"Reorder fields","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/field-order","href":"/api-reference/board/reorder-fields"},{"title":"List board field groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/groups","href":"/api-reference/board/list-board-field-groups"},{"title":"Create a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/groups","href":"/api-reference/board/create-a-field-group"},{"title":"Update a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/groups/{groupUuid}","href":"/api-reference/board/update-a-field-group"},{"title":"Get the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/get-the-create-card-form-order"},{"title":"Set the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/set-the-create-card-form-order"},{"title":"Get board access settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/shares","href":"/api-reference/board/get-board-access-settings"},{"title":"Get board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/theme","href":"/api-reference/board/get-board-identity-fields"},{"title":"Update board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/board/{boardId}/configuration/theme","href":"/api-reference/board/update-board-identity-fields"},{"title":"List board filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/filters","href":"/api-reference/board/list-board-filters"}]},{"group":"Company","pages":[{"title":"Get company info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/company/info","href":"/api-reference/company/get-company-info"}]},{"group":"Contacts","pages":[{"title":"Get conversations for contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/conversations","href":"/api-reference/contacts/get-conversations-for-contacts"},{"title":"Get contact conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/conversations","href":"/api-reference/contacts/get-contact-conversations"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Look up contacts by email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/by-email","href":"/api-reference/contacts/look-up-contacts-by-email"},{"title":"Initiate contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email","href":"/api-reference/contacts/initiate-contact-email-verification"},{"title":"Confirm contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email/{requestId}/confirm","href":"/api-reference/contacts/confirm-contact-email-verification"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/{contactId}","href":"/api-reference/contacts/update-a-contact"},{"title":"Get a contact's sentiment history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/sentiment","href":"/api-reference/contacts/get-a-contacts-sentiment-history"}]},{"group":"Knowledge","pages":[{"title":"Create a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/knowledge/create","href":"/api-reference/knowledge/create-a-knowledge-document"},{"title":"List knowledge documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/list","href":"/api-reference/knowledge/list-knowledge-documents"},{"title":"Get the knowledge document tree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/tree","href":"/api-reference/knowledge/get-the-knowledge-document-tree"},{"title":"List a knowledge document's direct children","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/children","href":"/api-reference/knowledge/list-a-knowledge-documents-direct-children"},{"title":"List saved knowledge document versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history","href":"/api-reference/knowledge/list-saved-knowledge-document-versions"},{"title":"Read a saved knowledge document version","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history/{versionId}","href":"/api-reference/knowledge/read-a-saved-knowledge-document-version"},{"title":"Get a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}","href":"/api-reference/knowledge/get-a-knowledge-document"},{"title":"Update a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/knowledge/{id}","href":"/api-reference/knowledge/update-a-knowledge-document"}]},{"group":"Email","pages":[{"title":"Create an email draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/create-draft","href":"/api-reference/email/create-an-email-draft"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/send","href":"/api-reference/email/send-an-email"}]},{"group":"App","pages":[{"title":"Verify a delegate token (keyless)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/verify","href":"/api-reference/app/verify-a-delegate-token-keyless"},{"title":"Get credential info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/me","href":"/api-reference/app/get-credential-info"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates","href":"/api-reference/templates/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/templates","href":"/api-reference/templates/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates/{id}","href":"/api-reference/templates/get-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/templates/{id}","href":"/api-reference/templates/update-a-template"}]},{"group":"Tasks","pages":[{"title":"Search tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/search","href":"/api-reference/tasks/search-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Update many tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/bulk-update","href":"/api-reference/tasks/update-many-tasks"},{"title":"Get a task by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tasks/{taskId}","href":"/api-reference/tasks/get-a-task-by-id"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tasks/{taskId}","href":"/api-reference/tasks/update-a-task"}]},{"group":"RoutingGroups","pages":[{"title":"List routing groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/routing-groups","href":"/api-reference/routinggroups/list-routing-groups"},{"title":"Create a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/create","href":"/api-reference/routinggroups/create-a-routing-group"},{"title":"Update a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/routing-groups/{id}","href":"/api-reference/routinggroups/update-a-routing-group"},{"title":"Archive a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/{id}/archive","href":"/api-reference/routinggroups/archive-a-routing-group"}]},{"group":"Files","pages":[{"title":"Get a presigned URL for a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-url","href":"/api-reference/files/get-a-presigned-url-for-a-direct-file-upload"},{"title":"Finalize a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-complete","href":"/api-reference/files/finalize-a-direct-file-upload"}]},{"group":"WebForms","pages":[{"title":"Submit a web form","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/web-forms/{formId}","href":"/api-reference/webforms/submit-a-web-form"}]},{"group":"Tours","pages":[{"title":"List tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/feedback","href":"/api-reference/tours/list-tour-feedback"},{"title":"Get one showing's tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/{showingId}/feedback","href":"/api-reference/tours/get-one-showings-tour-feedback"}]},{"group":"Docs","pages":[{"title":"Fetch this OpenAPI spec","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/docs/openapi","href":"/api-reference/docs/fetch-this-openapi-spec"}]}]}]},{"tab":"Aptly Portal","icon":"door-closed","pages":[{"title":"Aptly Portal","href":"/portal/introduction"}]}]},"basePath":"","title":"Volume health for an inbox against its own baseline - Aptly API","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}