Lytix helps team understand how individual users interact with their product. View high level overview of user activity, and filter (along with metadata and other attributes) to get more granular insights.
To get started, you’ll need to start passing a userId header when making requests via lytix.Click on the integration you’d like to use on the sidebar under Quickstart for the most up to date instructions. Here are some common ones:
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Lytix","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"favicon":"/logo/lytix-logo.svg","logo":{"light":"https://mintlify.s3-us-west-1.amazonaws.com/lytix/logo/lytix-logo.svg","dark":"https://mintlify.s3-us-west-1.amazonaws.com/lytix/logo/lytix-logo.svg"},"api":{"openapi":["api-reference/openapi.yml"]},"navbar":{"links":[{"label":"Support","href":"mailto:support@lytix.co"}],"primary":null},"footer":{"socials":{"github":"https://github.com/Lytix-Labs"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lytix","hasAudioNarration":false,"actualSubdomain":"lytix","customDomains":["docs.lytix.co"],"gitSource":{"type":"github","owner":"sidpremkumar","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e63294a5dc2e6daf36ec","collectionId":"0baa2ad3-fb7b-46f6-b0f8-88652c19cd6f","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e63294a5dc2e6daf36ec:success","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"API Keys","count":4},{"language":"default","tag":"Alerts","count":4},{"language":"default","tag":"Proxy","count":4},{"language":"default","tag":"API Reference","count":4},{"language":"default","tag":"Async Logging","count":2},{"language":"default","tag":"Caching","count":2},{"language":"default","tag":"Custom Errors","count":2},{"language":"default","tag":"Custom LLM Tracing","count":2},{"language":"default","tag":"Guardrails","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":"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":"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":"editor-version-history-v2","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":"billing-page-v2","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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"Users/user-overview","slug":"/Users/user-overview","pageMetadata":{"title":"User Overview","description":"How to capture user level data in lytix","href":"/Users/user-overview"},"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: \"How to capture user level data in lytix\"\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={a:`a`,code:`code`,img:`img`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Lytix helps team understand how individual users interact with their product. View high level overview of user activity, and filter (along with metadata and other attributes) to get more granular insights.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.img,{src:`https://lytix-cdn.s3.amazonaws.com/documentationAssets/customerUsers/userOverview.gif`,alt:`User Overview`})}),`\n`,_jsx(Heading,{level:`1`,id:`get-started`,children:`Get Started`}),`\n`,_jsxs(_components.p,{children:[`To get started, you’ll need to start passing a `,_jsx(_components.code,{children:`userId`}),` header when making requests via lytix.`]}),`\n`,_jsxs(_components.p,{children:[`Click on the integration you’d like to use on the sidebar under `,_jsx(_components.strong,{children:`Quickstart`}),` for the most up to date instructions. Here are some common ones:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:_jsx(_components.a,{href:`/Quickstart/openai-integration#userid`,children:`OpenAI`})})}),`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:_jsx(_components.a,{href:`/Quickstart/gemini-integration#optional-fields`,children:`Gemini`})})}),`\n`]})]})}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":"User Overview","description":"How to capture user level data in lytix","href":"/Users/user-overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get Started","slug":"get-started","depth":1,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"lytix","siteName":"Lytix","title":"User Overview - Lytix","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"Users/user-overview.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=\"How to capture user level data in lytix\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lytix\">\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/lytix/_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/lytix/_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/lytix/_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/lytix/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"User Overview - Lytix\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to capture user level data in lytix\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lytix\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lytix.co/Users/user-overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lytix.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=User+Overview\u0026amp;description=How+to+capture+user+level+data+in+lytix\u0026amp;theme=950fe68f562f23c275cf1e6d\u0026amp;signature=bf2f425d9c4dc6bafa9191a4bb3b31b4189de4663acc362f0822fd0fb92bcbf8\">\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=\"User Overview - Lytix\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to capture user level data in lytix\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lytix.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=User+Overview\u0026amp;description=How+to+capture+user+level+data+in+lytix\u0026amp;theme=950fe68f562f23c275cf1e6d\u0026amp;signature=bf2f425d9c4dc6bafa9191a4bb3b31b4189de4663acc362f0822fd0fb92bcbf8\">\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/lytix/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lytix\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lytix.co/Users/user-overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/Users/user-overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lytix.co/#organization\",\"name\":\"Lytix\",\"url\":\"https://docs.lytix.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/lytix/logo/lytix-logo.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lytix.co#website\",\"name\":\"Lytix\",\"url\":\"https://docs.lytix.co\",\"publisher\":{\"@id\":\"https://docs.lytix.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lytix.co/Users/user-overview#webpage\",\"url\":\"https://docs.lytix.co/Users/user-overview\",\"name\":\"User Overview\",\"description\":\"How to capture user level data in lytix\",\"isPartOf\":{\"@id\":\"https://docs.lytix.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lytix.co/Users/user-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lytix.co/Users/user-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lytix\",\"item\":\"https://docs.lytix.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"User Overview\",\"item\":\"https://docs.lytix.co/Users/user-overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.lytix.co/Users/user-overview#article\",\"headline\":\"User Overview\",\"name\":\"User Overview\",\"description\":\"How to capture user level data in lytix\",\"url\":\"https://docs.lytix.co/Users/user-overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lytix.co/Users/user-overview#webpage\"},\"publisher\":{\"@id\":\"https://docs.lytix.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lytix.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lytix\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lytix","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"}]},{"group":"API Keys","pages":[{"title":"Key Setup","href":"/APIKeys/api-key-setup"},{"title":"Setting API Key In Code","href":"/APIKeys/set-api-key-in-code"},{"title":"Environment Variable Setup","href":"/APIKeys/env-var-setup"},{"title":"Keys \u0026 Workflows","href":"/APIKeys/api-keys-and-workflows"}]},{"group":"Proxy","pages":[{"title":"OpenAI Integration","href":"/Quickstart/openai-integration"},{"title":"Vercel AI Integration","href":"/Quickstart/vercelai-integration"},{"title":"Gemini Integration","href":"/Quickstart/gemini-integration"},{"title":"Langchain Integration","href":"/Quickstart/langchain-integration"}]},{"group":"Image \u0026 Video","pages":[{"title":"Images","href":"/MultiModal/images"},{"title":"Video","href":"/MultiModal/video"}]},{"group":"Async Logging","pages":[{"title":"Quickstart","href":"/AsyncLogging/async-logging-setup"},{"title":"Manually Importing Events","href":"/Quickstart/manually-importing-events"}]},{"group":"Testing","pages":[{"title":"Agent as Judge","description":"How to use an agent as a judge","href":"/Testing/agent-as-judge"}]},{"group":"Users","pages":[{"title":"User Overview","href":"/Users/user-overview"},{"title":"Feedback","description":"How to capture user feedback in lytix","href":"/Users/feedback"}]},{"group":"Metadata","pages":[{"title":"Metadata","href":"/Metadata/metadata-setup"}]},{"group":"Workflows","pages":[{"title":"Workflow Setup","href":"/Workflows/workflows-setup"},{"title":"Custom Evaluations","href":"/Workflows/workflows-custom-evaluation"}]},{"group":"Datasets","pages":[{"title":"Datasets","href":"/Datasets/dataset-setup"}]},{"group":"Caching","pages":[{"title":"Caching Setup","href":"/Caching/caching-setup"},{"title":"Using Caching","href":"/Caching/using-caching"}]},{"group":"Playground","pages":[{"title":"Playground","href":"/Playground/playground"}]},{"group":"Alerts","pages":[{"title":"Alerts Overview","href":"/Alerts/overview"},{"title":"Alert Channels","href":"/Alerts/alert-channels"},{"title":"Custom Evaluation Alerts","href":"/Alerts/custom-evaluation-alerts"},{"title":"Custom Guardrail Alerts","href":"/Alerts/custom-guardrail-alerts"}]},{"group":"Bot Evaluation","pages":[{"title":"Session Evaluation Setup","href":"/SessionEvaluation/session-evaluation-setup"},{"title":"Push Session Data","href":"/SessionEvaluation/session-evaluation-push-sessions"}]},{"group":"Prompts","pages":[{"title":"Prompts","href":"/Prompts/prompts"}]},{"group":"Integrations","pages":[{"title":"Helicone","href":"/integrations/helicone"},{"title":"PostHog","href":"/integrations/posthog"}]},{"group":"Guardrails","pages":[{"title":"Guardrails","href":"/Guardrails/guardrails"},{"title":"Guardrails Setup","href":"/Guardrails/guardrails-setup"}]},{"group":"Custom Errors","pages":[{"title":"Custom Errors","href":"/CustomErrors/custom-errors"},{"title":"Custom Errors Setup","href":"/CustomErrors/custom-errors-setup"}]},{"group":"Custom LLM Tracing","pages":[{"title":"Custom LLM Tracing","href":"/CustomLLMTracing/custom-llm-tracing"},{"title":"Custom LLM Tracing Setup","href":"/CustomLLMTracing/custom-llm-tracing-setup"}]},{"group":"CLI","pages":[{"title":"CLI Login","href":"/CLI/cli-login"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"title":"User Overview - Lytix","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-D7yRe3On.js","lightbox-handle-r17bVUz3.js"]}