{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Telemetree Docs","colors":{"primary":"#0098EA","light":"#0098EA","dark":"#3C6BF3"},"favicon":"/tele-favicon.svg","logo":{"light":"https://mintcdn.com/telemetree/akp6XNv3V6IKBA56/logo/tele-light.svg?fit=max\u0026auto=format\u0026n=akp6XNv3V6IKBA56\u0026q=85\u0026s=e1ec29e0c9d8ea7e6a85d9bb58b4c3df","dark":"https://mintcdn.com/telemetree/akp6XNv3V6IKBA56/logo/tele-dark.svg?fit=max\u0026auto=format\u0026n=akp6XNv3V6IKBA56\u0026q=85\u0026s=5504f2dc3d45a4e84f07633fb7b24e59"},"navbar":{"links":[{"label":"Support","href":"mailto:chris@telemetree.io"}],"primary":{"type":"button","label":"Start growing","href":"https://app.telemetree.io/auth?ref=docs"}},"footer":{"socials":{"x":"https://x.com/telemetree_HQ/","github":"https://github.com/Telemetree/","linkedin":"https://www.linkedin.com/company/telemetree/"}},"navigation":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.telemetree.io","icon":"book-open-cover"},{"anchor":"Dashboard","href":"https://app.telemetree.io","icon":"square-terminal"},{"anchor":"Community","href":"https://t.me/telemetree_en","icon":"telegram"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"telemetree","hasAudioNarration":false,"actualSubdomain":"telemetree","customDomains":["docs.telemetree.io"],"gitSource":{"type":"github","owner":"telemetree","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c538cf0492c7637e5891","collectionId":"db23f0d5-c01b-4e5f-a8ee-21c02ffd5050","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae920e32e86bd0c182f8dfe:success","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"API References","count":14},{"language":"default","tag":"Analytics SDKs","count":7},{"language":"default","tag":"Monthly Active Users API","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Backend SDKs","count":3},{"language":"default","tag":"Frontend SDKs","count":3},{"language":"default","tag":"Enterprise API","count":3},{"language":"default","tag":"Misc","count":2},{"language":"default","tag":"Resources","count":2}]},"assistantConfig":{},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/retention-api/get-retention-analysis","slug":"/api-reference/retention-api/get-retention-analysis","pageMetadata":{"title":"Get Retention Analysis","description":"**Description:** Retrieves retention analysis based on the specified start and end dates.\n\n**Parameters:**\n- `period`: The start and end dates\n\n**Header**\n- `x-api-key`: Your API Key (Dashboard->Settings)\n\n**Returns:**\n- `RetentionAnalysisResponse`: The transformed retention analysis data.\n\n**Raises:**\n- `HTTPException`: If an error occurs during the retrieval process.","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /retention","href":"/api-reference/retention-api/get-retention-analysis","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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Description:\"\n }), \" Retrieves retention analysis based on the specified start and end dates.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Parameters:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"period\"\n }), \": The start and end dates\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Header\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"x-api-key\"\n }), \": Your API Key (Dashboard->Settings)\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Returns:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"RetentionAnalysisResponse\"\n }), \": The transformed retention analysis data.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Raises:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"HTTPException\"\n }), \": If an error occurs during the retrieval process.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Retention Analysis","description":"**Description:** Retrieves retention analysis based on the specified start and end dates.\n\n**Parameters:**\n- `period`: The start and end dates\n\n**Header**\n- `x-api-key`: Your API Key (Dashboard->Settings)\n\n**Returns:**\n- `RetentionAnalysisResponse`: The transformed retention analysis data.\n\n**Raises:**\n- `HTTPException`: If an error occurs during the retrieval process.","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /retention","href":"/api-reference/retention-api/get-retention-analysis","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Retention API"],"summary":"Get Retention Analysis","description":"**Description:** Retrieves retention analysis based on the specified start and end dates.\n\n**Parameters:**\n- `period`: The start and end dates\n\n**Header**\n- `x-api-key`: Your API Key (Dashboard->Settings)\n\n**Returns:**\n- `RetentionAnalysisResponse`: The transformed retention analysis data.\n\n**Raises:**\n- `HTTPException`: If an error occurs during the retrieval process.","operationId":"Get_retention_analysis_retention_get","security":["8511f183-88dc-429f-85bb-57e1e74e1e47"],"parameters":["a67b1a45-2fe2-41bd-b7a6-4f6a61805571","ec8d68a3-4108-4e32-9e7d-366a1369c698","4836f373-314a-4b4b-9929-a93fd1438061","ac548df0-8d37-4413-9a87-a09c3965f2a3"],"responses":{"200":"2ee0fa73-3b0c-4374-b24a-46392ef5d9b2","422":"c55e23a8-602f-45af-8017-2e34bcd637f0"},"method":"get","type":"path","servers":["23a32496-7ca3-4b76-93ad-57dda6ca87f5"],"path":"/retention","baseUrlOptions":["https://ebn.telemetree.io/public-api"],"title":"Get Retention Analysis","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a67b1a45-2fe2-41bd-b7a6-4f6a61805571":{"name":"group_by","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Group By","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Group By","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"example":"country"},"ec8d68a3-4108-4e32-9e7d-366a1369c698":{"name":"start","in":"query","required":true,"schema":{"type":"string","description":"Start date in YYYYMMDD format","title":"Start","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Start date in YYYYMMDD format","example":"20240801"},"4836f373-314a-4b4b-9929-a93fd1438061":{"name":"end","in":"query","required":true,"schema":{"type":"string","description":"End date in YYYYMMDD format","title":"End","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"End date in YYYYMMDD format","example":"20240830"},"ac548df0-8d37-4413-9a87-a09c3965f2a3":{"name":"filters","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Filters","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Filters","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"responses":{"2ee0fa73-3b0c-4374-b24a-46392ef5d9b2":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"cohorts":{"additionalProperties":{"additionalProperties":{"properties":{"totalUsers":{"type":"integer","title":"Totalusers","description":"The total number of users","isRequired":true,"uniqueKey":"data.items.[INDEX].cohorts.additionalProperties.additionalProperties.totalUsers","typeLabel":"integer"},"retention":{"additionalProperties":{"type":"number","uniqueKey":"data.items.[INDEX].cohorts.additionalProperties.additionalProperties.retention.additionalProperties","typeLabel":"number"},"type":"object","title":"Retention","description":"The retention","isRequired":true,"uniqueKey":"data.items.[INDEX].cohorts.additionalProperties.additionalProperties.retention","typeLabel":"Retention · object"}},"type":"object","required":["totalUsers","retention"],"title":"CohortsRetentionEntry","uniqueKey":"data.items.[INDEX].cohorts.additionalProperties.additionalProperties","typeLabel":"CohortsRetentionEntry · object"},"type":"object","uniqueKey":"data.items.[INDEX].cohorts.additionalProperties","typeLabel":"object"},"type":"object","title":"Cohorts","description":"The cohorts","isRequired":true,"uniqueKey":"data.items.[INDEX].cohorts","typeLabel":"Cohorts · object"},"retentionMatrix":{"items":{"items":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].retentionMatrix.items.[INDEX].items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].retentionMatrix.items.[INDEX].items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"data.items.[INDEX].retentionMatrix.items.[INDEX].items.[INDEX]","typeLabel":"string | number"},"type":"array","uniqueKey":"data.items.[INDEX].retentionMatrix.items.[INDEX]","typeLabel":"(string | number)[]"},"type":"array","title":"Retentionmatrix","description":"The retention matrix","isRequired":true,"uniqueKey":"data.items.[INDEX].retentionMatrix","typeLabel":"((string | number)[])[]"},"combinedRetention":{"items":{"type":"number","uniqueKey":"data.items.[INDEX].combinedRetention.items.[INDEX]","typeLabel":"number"},"type":"array","title":"Combinedretention","description":"The combined retention","isRequired":true,"uniqueKey":"data.items.[INDEX].combinedRetention","typeLabel":"number[]"},"totalUsers":{"type":"integer","title":"Totalusers","description":"The total number of users","isRequired":true,"uniqueKey":"data.items.[INDEX].totalUsers","typeLabel":"integer"},"groupBy":{"oneOf":[{"type":"string","title":"Groupby","description":"The group by","isRequired":true,"uniqueKey":"data.items.[INDEX].groupBy.oneOf.0","typeLabel":"string"},{"type":"null","title":"Groupby","description":"The group by","isRequired":true,"uniqueKey":"data.items.[INDEX].groupBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].groupBy","typeLabel":"string | null"},"groups":{"oneOf":[{"type":"array","items":{"additionalProperties":{"properties":{"cohorts":{"additionalProperties":{"additionalProperties":{"properties":{"totalUsers":{"type":"integer","title":"Totalusers","description":"The total number of users","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts.additionalProperties.additionalProperties.totalUsers","typeLabel":"integer"},"retention":{"additionalProperties":{"type":"number","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts.additionalProperties.additionalProperties.retention.additionalProperties","typeLabel":"number"},"type":"object","title":"Retention","description":"The retention","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts.additionalProperties.additionalProperties.retention","typeLabel":"Retention · object"}},"type":"object","required":["totalUsers","retention"],"title":"CohortsRetentionEntry","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts.additionalProperties.additionalProperties","typeLabel":"CohortsRetentionEntry · object"},"type":"object","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts.additionalProperties","typeLabel":"object"},"type":"object","title":"Cohorts","description":"The cohorts","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.cohorts","typeLabel":"Cohorts · object"},"retentionMatrix":{"items":{"items":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.retentionMatrix.items.[INDEX].items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.retentionMatrix.items.[INDEX].items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.retentionMatrix.items.[INDEX].items.[INDEX]","typeLabel":"string | number"},"type":"array","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.retentionMatrix.items.[INDEX]","typeLabel":"(string | number)[]"},"type":"array","title":"Retentionmatrix","description":"The retention matrix","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.retentionMatrix","typeLabel":"((string | number)[])[]"},"combinedRetention":{"items":{"type":"number","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.combinedRetention.items.[INDEX]","typeLabel":"number"},"type":"array","title":"Combinedretention","description":"The combined retention","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.combinedRetention","typeLabel":"number[]"},"totalUsers":{"type":"integer","title":"Totalusers","description":"The total number of users","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties.totalUsers","typeLabel":"integer"}},"type":"object","required":["cohorts","retentionMatrix","combinedRetention","totalUsers"],"title":"RetentionDataGroup","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"RetentionDataGroup · object"},"type":"object","uniqueKey":"data.items.[INDEX].groups.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Groups","description":"The groups","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.0","typeLabel":"Groups · object[]"},{"type":"null","title":"Groups","description":"The groups","isRequired":true,"uniqueKey":"data.items.[INDEX].groups.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].groups","typeLabel":"Groups · object[] | null"}},"type":"object","required":["cohorts","retentionMatrix","combinedRetention","totalUsers","groupBy","groups"],"title":"RetentionDataMain","uniqueKey":"data.items.[INDEX]","typeLabel":"RetentionDataMain · object"},"type":"array","title":"Data","description":"The retention data","isRequired":true,"uniqueKey":"data","typeLabel":"RetentionDataMain · object[]"}},"type":"object","required":["data"],"title":"RetentionDataResponse","uniqueKey":"","typeLabel":"RetentionDataResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"cohorts":{},"retentionMatrix":[["\u003cstring>"]],"combinedRetention":[123],"totalUsers":123,"groupBy":"\u003cstring>","groups":[{}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c55e23a8-602f-45af-8017-2e34bcd637f0":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8511f183-88dc-429f-85bb-57e1e74e1e47":{"api_key":{"type":"apiKey","description":"Your API Key (Dashboard->Settings)","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"23a32496-7ca3-4b76-93ad-57dda6ca87f5":{"url":"https://ebn.telemetree.io/public-api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your API Key (Dashboard->Settings)","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"Your API Key (Dashboard->Settings)","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"x-api-key"}],"title":"api_key"}]},"originalFileLocation":"https://ebn.telemetree.io/public-api/openapi.json"},"subdomain":"telemetree","siteName":"Telemetree Docs","title":"Get Retention Analysis - Telemetree Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:45:51.924Z","originalFileLocation":"api-reference/retention-api/get-retention-analysis.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=\"Description: Retrieves retention analysis based on the specified start and end dates. Parameters: - period: The start and end dates Header - x-api-key: Your API Key (Dashboard-\u0026gt;Settings) Returns: - RetentionAnalysisResponse: The transformed retention analysis data. Raises: - HTTPException: If an error occurs during the retrieval process.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Telemetree Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_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/telemetree/NQ5PsmVcfIWkTsAR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Retention Analysis - Telemetree Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Description: Retrieves retention analysis based on the specified start and end dates. Parameters: - period: The start and end dates Header - x-api-key: Your API Key (Dashboard-\u0026gt;Settings) Returns: - RetentionAnalysisResponse: The transformed retention analysis data. Raises: - HTTPException: If an error occurs during the retrieval process.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Telemetree Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telemetree.mintlify.site/_mintlify/api/og/v2?division=Retention+API\u0026amp;title=Get+Retention+Analysis\u0026amp;description=**Description%3A**+Retrieves+retention+analysis+based+on+the+specified+start+and+end+dates.%0A%0A**Parameters%3A**%0A-+%60period%60%3A+The+start+and+end+dates%0A%0A**Header**%0A-+%60x-\u0026amp;theme=da4e9451f97bf80a1a2bd32f\u0026amp;signature=6a48055dedd3631605f0783755654d03f8dc9c9cbbffbee844f2de99c6e83c7c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Retention Analysis - Telemetree Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Description: Retrieves retention analysis based on the specified start and end dates. Parameters: - period: The start and end dates Header - x-api-key: Your API Key (Dashboard-\u0026gt;Settings) Returns: - RetentionAnalysisResponse: The transformed retention analysis data. Raises: - HTTPException: If an error occurs during the retrieval process.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://telemetree.mintlify.site/_mintlify/api/og/v2?division=Retention+API\u0026amp;title=Get+Retention+Analysis\u0026amp;description=**Description%3A**+Retrieves+retention+analysis+based+on+the+specified+start+and+end+dates.%0A%0A**Parameters%3A**%0A-+%60period%60%3A+The+start+and+end+dates%0A%0A**Header**%0A-+%60x-\u0026amp;theme=da4e9451f97bf80a1a2bd32f\u0026amp;signature=6a48055dedd3631605f0783755654d03f8dc9c9cbbffbee844f2de99c6e83c7c\">\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/telemetree/NQ5PsmVcfIWkTsAR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Telemetree Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0098EA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/retention-api/get-retention-analysis.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.telemetree.io/#organization\",\"name\":\"Telemetree Docs\",\"url\":\"https://docs.telemetree.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/telemetree/akp6XNv3V6IKBA56/logo/tele-light.svg?fit=max\u0026auto=format\u0026n=akp6XNv3V6IKBA56\u0026q=85\u0026s=e1ec29e0c9d8ea7e6a85d9bb58b4c3df\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.telemetree.io#website\",\"name\":\"Telemetree Docs\",\"url\":\"https://docs.telemetree.io\",\"publisher\":{\"@id\":\"https://docs.telemetree.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis#webpage\",\"url\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis\",\"name\":\"Get Retention Analysis\",\"description\":\"Description: Retrieves retention analysis based on the specified start and end dates. Parameters: - period: The start and end dates Header - x-api-key: Your API Key (Dashboard->Settings) Returns: - RetentionAnalysisResponse: The transformed retention analysis data. Raises: - HTTPException: If an error occurs during the retrieval process.\",\"dateModified\":\"2026-01-07T02:45:51.924Z\",\"isPartOf\":{\"@id\":\"https://docs.telemetree.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Telemetree Docs\",\"item\":\"https://docs.telemetree.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Retention Analysis\",\"item\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis#apireference\",\"headline\":\"Get Retention Analysis\",\"name\":\"Get Retention Analysis\",\"description\":\"Description: Retrieves retention analysis based on the specified start and end dates. Parameters: - period: The start and end dates Header - x-api-key: Your API Key (Dashboard->Settings) Returns: - RetentionAnalysisResponse: The transformed retention analysis data. Raises: - HTTPException: If an error occurs during the retrieval process.\",\"url\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis\",\"mainEntityOfPage\":{\"@id\":\"https://docs.telemetree.io/api-reference/retention-api/get-retention-analysis#webpage\"},\"dateModified\":\"2026-01-07T02:45:51.924Z\",\"publisher\":{\"@id\":\"https://docs.telemetree.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.telemetree.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Telemetree Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Telemetree Docs","nav":{"global":{"anchors":[{"anchor":"Documentation","href":"https://docs.telemetree.io","icon":"book-open-cover"},{"anchor":"Dashboard","href":"https://app.telemetree.io","icon":"square-terminal"},{"anchor":"Community","href":"https://t.me/telemetree_en","icon":"telegram"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/quickstart"}]},{"tab":"API References","groups":[{"group":"Monthly Active Users API","pages":[{"title":"Register Application","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json post /applications/register","href":"/api-reference/monthly-active-users-api/register-application"},{"title":"Monthly Active Users Overview","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /monthly-active-users/growth-trend","href":"/api-reference/monthly-active-users-api/monthly-active-users-overview"},{"title":"Monthly Active Users Based On Handle","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /monthly-active-users/growth-trend/{handle}","href":"/api-reference/monthly-active-users-api/monthly-active-users-based-on-handle"},{"title":"Monthly Active Users Timeseries Based On Handle","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /monthly-active-users/timeseries/{handle}","href":"/api-reference/monthly-active-users-api/monthly-active-users-timeseries-based-on-handle"}]},{"group":"Events API","pages":[{"title":"Get Average Session Length","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /sessions/average","href":"/api-reference/events-api/get-average-session-length"},{"title":"Get Events Segmentation","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /events/segmentation","href":"/api-reference/events-api/get-events-segmentation"}]},{"group":"Funnels API","pages":[{"title":"Get Funnel Analysis","description":"**Description:** Retrieves funnel data based on the specified events, start and end dates,\nand filters.\n\n**Parameters:**\n- `events`: List of events\n- `filters`: List of filters in Amplitude-like format\n- `group_by`: List of fields to group by\n- `period`: The start and end dates\n\n**Header**\n- `x-api-key`: Your API Key (Dashboard->Settings)\n\n**Returns:**\n- `FunnelAnalysisResponse`: The transformed funnel data.\n\n**Raises:**\n- `HTTPException`: If an error occurs during the retrieval process.","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /funnels","href":"/api-reference/funnels-api/get-funnel-analysis"}]},{"group":"Retention API","pages":[{"title":"Get Retention Analysis","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /retention","href":"/api-reference/retention-api/get-retention-analysis"}]},{"group":"User API","pages":[{"title":"Get User Segmentation","description":"**Description:** Retrieves user information based on the specified filters.\n\n**Parameters:**\n- `language`: The language. Use country code (ex: 'en', 'ru', 'es', etc.)\n- `utm`: The start parameter\n- `is_premium`: Whether the user is premium\n- `country`: The country\n- `city`: The city\n\n\n**Header**\n- `x-api-key`: Your API Key (Dashboard->Settings)\n\n**Returns:**\n- `UserSegmentationResponse`: The response containing the user segmentation data. It contains the following fields:\n - `data`: The list of user segmentation entries. It contains the following fields:\n - `telegram_id`: The Telegram ID of the user.\n - `language`: The language of the user. Defaults to None.\n - `utm`: The start parameter of the user. Defaults to None.\n - `is_premium`: Whether the user is premium. Defaults to False.\n - `first_active_at`: The first active date of the user.\n - `country`: The country of the user. Defaults to None.\n - `city`: The city of the user. Defaults to None.\n - `total_events`: The total number of events from the user in your application.\n - `total_sessions`: The total number of sessions from the user in your application.\n - `username`: The username of the user. Defaults to None.\n - `firstname`: The first name of the user. Defaults to None.\n - `lastname`: The last name of the user. Defaults to None.\n - `last_active_at`: The last active date of the user.\n - `device`: The device of the user. Defaults to None.\n - `brand`: The brand of the user. Defaults to None.\n - `model`: The model of the user. Defaults to None.\n - `limit`: The number of items per page.\n - `offset`: The number of items to skip.\n - `status_code`: The status code of the response.\n - `message`: The message of the response.\n\n**Raises:**\n- `HTTPException`: If an error occurs during the retrieval process.","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /users/segmentation","href":"/api-reference/user-api/get-user-segmentation"},{"title":"Get User Aggregated Segmentation","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /users/segmentation/aggregated","href":"/api-reference/user-api/get-user-aggregated-segmentation"}]},{"group":"Enterprise API","pages":[{"title":"Application Handles","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /enterprise/available-handles","href":"/api-reference/enterprise-api/application-handles"},{"title":"Enterprise Handle","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /enterprise/{handle}","href":"/api-reference/enterprise-api/enterprise-handle"},{"title":"Enterprise Premium Timeseries Distribution","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /enterprise/{handle}/premium-timeseries","href":"/api-reference/enterprise-api/enterprise-premium-timeseries-distribution"}]},{"group":"Telemetree Data Pipeline","pages":[{"title":"Get Application Config","deprecated":null,"version":null,"openapi":"https://ebn.telemetree.io/public-api/openapi.json get /v1/client/config","href":"/api-reference/telemetree-data-pipeline/get-application-config"}]}]},{"tab":"Content","pages":[{"title":"Content","href":"/introduction"}]},{"tab":"Dashboard","href":"https://app.telemetree.io"}]},"basePath":"","title":"Get Retention Analysis - Telemetree Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}