Welcome to the Travtus Documentation Site. Here you will find a comprehensive overview of how to use the Travtus platform. Including best practice, use cases, feature deep dives and FAQs.
Getting Started
Getting going with the Gateway and More…
Technical Guide
Technical docs for technical teams…
API Guide
How to use the Travtus api…
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Travtus","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/travtus-33/BbquytAFybLqihed/logo/logo-light.png?fit=max\u0026auto=format\u0026n=BbquytAFybLqihed\u0026q=85\u0026s=04b7b6da5c7cd1d68da724023f8d53b5","dark":"https://mintcdn.com/travtus-33/BbquytAFybLqihed/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=BbquytAFybLqihed\u0026q=85\u0026s=b682152402d14ed5a2b10d019ca59cef"},"favicon":"https://mintcdn.com/travtus-33/36YTU5YCNjti7vlR/favicon.png?fit=max\u0026auto=format\u0026n=36YTU5YCNjti7vlR\u0026q=85\u0026s=c78597249a20cdf207b45bb8cf968af7","api":{"mdx":{"server":["https://api.travtus.com","https://apiuat.travtus.com"]}},"appearance":{"default":"light"},"footer":{"socials":{"twitter":"https://twitter.com/adambytravtus","linkedin":"https://www.linkedin.com/company/travtusofficialpage/mycompany"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"travtus-33","hasAudioNarration":false,"actualSubdomain":"travtus-33","customDomains":["docs2.travtus.com"],"gitSource":{"type":"github","owner":"travtus","repo":"adam-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a730304130f696f37648566","collectionId":"7427e758-7fd3-41fd-81d0-72efc53bf08b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a730304130f696f37648566"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a730304130f696f37648566:success","clientVersion":"0.0.3902","searchFilterCounts":[{"language":"default","tag":"Platform Guide","count":42},{"language":"default","tag":"API Guide","count":29},{"language":"default","tag":"Features","count":28},{"language":"default","tag":"Technical Guide","count":26},{"language":"default","tag":"Endpoints","count":22},{"language":"default","tag":"Connect - File Uploads","count":15},{"language":"default","tag":"Data Types","count":11},{"language":"default","tag":"Communities","count":8},{"language":"default","tag":"Use Cases","count":7},{"language":"default","tag":"Introduction","count":6}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"platform-introduction","slug":"/platform-introduction","pageMetadata":{"title":"Welcome","description":"Welcome to the Travtus Platform","href":"/platform-introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to the Travtus Platform\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,Columns}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Columns)_missingMdxReference(`Columns`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the Travtus Documentation Site. Here you will find a comprehensive overview of how to use the Travtus platform. Including best practice, use cases, feature deep dives and FAQs.`}),`\n`,_jsxs(Columns,{cols:3,children:[_jsx(Card,{title:`Getting Started`,icon:`panel-left-close`,href:`/getting-started-with-travtus/accessing-the-gateway`,children:_jsx(_components.p,{children:`Getting going with the Gateway and More…`})}),_jsx(Card,{title:`Technical Guide`,icon:`panel-middle-close`,href:`/introduction`,children:_jsx(_components.p,{children:`Technical docs for technical teams…`})}),_jsx(Card,{title:`API Guide`,icon:`panel-right-close`,href:`/api-introduction`,children:_jsx(_components.p,{children:`How to use the Travtus api…`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome","description":"Welcome to the Travtus Platform","href":"/platform-introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"travtus-33","siteName":"Travtus","title":"Welcome - Travtus","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"platform-introduction.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=\"light\"}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=\"Welcome to the Travtus Platform\">\u003cmeta data-mint-head name=\"application-name\" content=\"Travtus\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_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/travtus-33/8CBILSCY8owLWaEL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome - Travtus\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Travtus Platform\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Travtus\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs2.travtus.com/platform-introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Welcome - Travtus\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Travtus Platform\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/travtus-33/8CBILSCY8owLWaEL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Travtus\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs2.travtus.com/platform-introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs2.travtus.com/#organization\",\"name\":\"Travtus\",\"url\":\"https://docs2.travtus.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/travtus-33/BbquytAFybLqihed/logo/logo-light.png?fit=max\u0026auto=format\u0026n=BbquytAFybLqihed\u0026q=85\u0026s=04b7b6da5c7cd1d68da724023f8d53b5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs2.travtus.com#website\",\"name\":\"Travtus\",\"url\":\"https://docs2.travtus.com\",\"publisher\":{\"@id\":\"https://docs2.travtus.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs2.travtus.com/platform-introduction#webpage\",\"url\":\"https://docs2.travtus.com/platform-introduction\",\"name\":\"Welcome\",\"description\":\"Welcome to the Travtus Platform\",\"isPartOf\":{\"@id\":\"https://docs2.travtus.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs2.travtus.com/platform-introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs2.travtus.com/platform-introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Travtus\",\"item\":\"https://docs2.travtus.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Welcome\",\"item\":\"https://docs2.travtus.com/platform-introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs2.travtus.com/platform-introduction#article\",\"headline\":\"Welcome\",\"name\":\"Welcome\",\"description\":\"Welcome to the Travtus Platform\",\"url\":\"https://docs2.travtus.com/platform-introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs2.travtus.com/platform-introduction#webpage\"},\"publisher\":{\"@id\":\"https://docs2.travtus.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs2.travtus.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Travtus\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Travtus","nav":{"global":null,"tabs":[{"tab":"Platform Guide","groups":[{"group":"Introduction","pages":[{"title":"Welcome","href":"/platform-introduction"}]},{"group":"Getting started with Travtus","pages":[{"title":"Accessing the Gateway","description":"Learn how to access the Gateway","sidebarTitle":"Accessing the Gateway","href":"/getting-started-with-travtus/accessing-the-gateway"},{"title":"Initial Setup","href":"/getting-started-with-travtus/initial-setup"},{"title":"How does it work?","href":"/getting-started-with-travtus/how-does-it-work"},{"title":"Connecting data sources","href":"/getting-started-with-travtus/connecting-data-sources"},{"title":"Logging in for the first time","href":"/getting-started-with-travtus/logging-in-for-the-first-time"},{"title":"Re-enabling Chrome Extension","href":"/getting-started-with-travtus/re-enabling-chrome-extension"}]},{"group":"Use Cases","pages":[{"title":"Reputation Management","href":"/getting-started-with-travtus/use-cases/ReputationManagement"},{"title":"Customer Experience","href":"/getting-started-with-travtus/use-cases/CustomerExperience"},{"title":"Staffing","href":"/getting-started-with-travtus/use-cases/Staffing"},{"title":"Regional Managers","href":"/getting-started-with-travtus/use-cases/RegionalManagers"},{"title":"Marketing","href":"/getting-started-with-travtus/use-cases/Marketing"},{"title":"Central Teams","href":"/getting-started-with-travtus/use-cases/CentralTeams"},{"title":"Onsite Teams","href":"/getting-started-with-travtus/use-cases/OnsiteTeams"}]},{"group":"Features","pages":[{"group":"Home Page","pages":[{"title":"Newsfeed","href":"/features/home-page/newsfeed"},{"title":"Insights","href":"/features/home-page/Insights"},{"title":"Search History","href":"/features/home-page/search-history"},{"title":"Quality Assurance [Beta]","href":"/features/home-page/quality-assurance-beta"},{"title":"Conversational Scores","href":"/features/home-page/conversational-scores"}]},{"group":"Communities","pages":[{"title":"Community Summary","href":"/features/communities/community-summary"},{"title":"Top Resident Goals","href":"/features/communities/top-resident-goals"},{"title":"Community Action Plan","href":"/features/communities/community-action-plan"},{"title":"Community Scoring and Trending","href":"/features/communities/community-scoring-and-trending"},{"title":"Customers Requiring Attention","href":"/features/communities/customers-requiring-attention"},{"title":"Industry Benchmarking","href":"/features/communities/industry-benchmarking"},{"title":"Community Groups","href":"/features/communities/community-groups"},{"title":"Community Maps","href":"/features/communities/community-maps"}]},{"group":"Customers","pages":[{"title":"Customer Profile Overview","href":"/features/customers/customer-profile-overview"},{"title":"Customer Summary","href":"/features/customers/customer-summary"},{"title":"Customer Experience Scoring","href":"/features/customers/customer-experience-scoring"},{"title":"Customer Conversation History","href":"/features/customers/customer-conversation-history"},{"title":"Customer Action Plans","href":"/features/customers/customer-action-plans"}]},{"group":"Data","pages":[{"title":"Tracking Goals","href":"/features/data/tracking-goals"},{"title":"Exploring Your Data: Volumes","href":"/features/data/exploring-your-data-volumes"},{"title":"Exploring Your Data: Content","href":"/features/data/exploring-your-data-content"},{"title":"Tracked Goal Overview","href":"/features/data/tracked-goal-overview"}]},{"group":"Explore","pages":[{"title":"How to use Explore","href":"/features/explore/how-to-use-explore"},{"title":"Related Search Results","href":"/features/explore/related-search-results"},{"title":"Citations","href":"/features/explore/citations"},{"title":"Explore Experts","href":"/features/explore/explore-experts"}]},{"group":"Smart Tasks","pages":[{"title":"My Tasks","href":"/features/smart-tasks/my-tasks"}]},{"group":"Studio","pages":[{"title":"Adding users, communities and roles.","href":"/features/studio/studio"}]},{"group":"Workflows","pages":[{"title":"Customer service agent","href":"/features/teammates/adam/customer-service-agent"}]}]}]},{"tab":"Technical Guide","pages":[{"title":"Technical Guide","href":"/introduction"}]},{"tab":"API Guide","pages":[{"title":"API Guide","href":"/api-introduction"}]}]},"title":"Welcome - Travtus","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":[],"chunks":[]}