Real-time HTTP APIs for user and company identification and event tracking in Userpilot.
These APIs allow you to identify users and companies, update their profiles in bulk, and track custom events in real time. Integrate these endpoints with your backend or service to keep your Userpilot data up-to-date and actionable.
Identify User: Create or update individual user profiles, or update multiple users in bulk. Useful for onboarding, profile updates, and large-scale data syncs.
Identify Company: Create or update individual company profiles, or update multiple companies in bulk. Ideal for B2B platforms and company-level analytics.
Track Event: Record custom events for users to monitor engagement, feature usage, and more.
The real-time HTTP APIs enforce rate limiting to ensure optimal performance and fair usage across all applications. Understanding these limits helps you design robust integrations that work efficiently within the platform’s constraints.
Implement Exponential Backoff: When you receive a 429 error, wait progressively longer before retrying (e.g., 1s, 2s, 4s, 8s).Monitor Your Usage: Track your request patterns to stay within limits and optimize your integration performance.Handle Errors Gracefully: Always implement proper error handling for rate limit responses in your applications.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Userpilot Knowledge Base","colors":{"primary":"#6765e8","light":"#9a98f0","dark":"#343374"},"logo":{"light":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-dark.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=ed5988b05e17770537d7327506be349c","dark":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-light.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=2558daac7455ff6275b45a01cecb8ca9"},"favicon":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-favicon.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=bd3fb42ae91a32d13d543fed45a8b88e","footer":{"socials":{"twitter":"https://linkedin.com/company/teamuserpilot","facebook":"https://facebook.com/userpilot","linkedin":"https://linkedin.com/company/teamuserpilot"},"links":[{"header":"Support","items":[{"label":"support@userpilot.com","href":"mailto:support@userpilot.com"}]}]},"seo":{"metatags":{"canonical":"https://docs.userpilot.com","og:site_name":"Userpilot Knowledge Base","og:type":"website","og:image":"https://docs.userpilot.com/up-logo-dark.svg","twitter:card":"summary_large_image","twitter:site":"@usaborpilot"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userpilot","hasAudioNarration":false,"actualSubdomain":"userpilot","customDomains":["docs.userpilot.com"],"gitSource":{"type":"github","owner":"userpilot","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0b2192ea1296893eaac7f","collectionId":"fc844142-bc45-4b7f-9358-b6510c66635c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0b2192ea1296893eaac7f"},"feedback":{"edits":true,"issues":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7105b88760f93b1002721","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Platform","count":137},{"language":"default","tag":"Developer","count":88},{"language":"default","tag":"Installation","count":76},{"language":"default","tag":"Mobile","count":68},{"language":"default","tag":"In App Engagement","count":56},{"language":"default","tag":"APIs","count":42},{"language":"default","tag":"Configure","count":23},{"language":"default","tag":"Endpoints","count":20},{"language":"default","tag":"Bulk Export","count":17},{"language":"default","tag":"Integrations","count":14}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--primary:103 101 232;--primary-light:225 224 250;--primary-dark:103 101 232;--background-light:255 255 255;--background-dark:9 13 13;--gray-50:243 247 246;--gray-100:238 242 241;--gray-200:222 226 226;--gray-300:206 210 209;--gray-400:158 163 162;--gray-500:112 116 115;--gray-600:80 84 83;--gray-700:62 67 66;--gray-800:37 41 40;--gray-900:23 27 26;--gray-950:10 14 13;--header:128 127 236;--hover-btn:52 51 116;--accent:103 101 232}header#header>div>div{color:rgb(var(--header))}body :is(.dark\\:bg-primary-light:is(.dark *)){background:rgb(var(--accent))}body :is(.dark\\:bg-primary-light\\/10:is(.dark *)){background:rgb(var(--hover-btn))}"}],"page":{"pagePath":"api-references/real-time/overview","slug":"/api-references/real-time/overview","pageMetadata":{"title":"Overview","description":"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.","keywords":["Userpilot","API","user","company","event","tracking"],"href":"/api-references/real-time/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: \"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\"\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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`These APIs allow you to identify users and companies, update their profiles in bulk, and track custom events in real time. Integrate these endpoints with your backend or service to keep your Userpilot data up-to-date and actionable.`}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-references/real-time/identify-user`,children:_jsx(_components.strong,{children:`Identify User`})}),`: Create or update individual user profiles, or update multiple users in bulk. Useful for onboarding, profile updates, and large-scale data syncs.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-references/real-time/identify-company`,children:_jsx(_components.strong,{children:`Identify Company`})}),`: Create or update individual company profiles, or update multiple companies in bulk. Ideal for B2B platforms and company-level analytics.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-references/real-time/track-event`,children:_jsx(_components.strong,{children:`Track Event`})}),`: Record custom events for users to monitor engagement, feature usage, and more.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsx(_components.p,{children:`The real-time HTTP APIs enforce rate limiting to ensure optimal performance and fair usage across all applications. Understanding these limits helps you design robust integrations that work efficiently within the platform’s constraints.`}),`\n`,_jsx(Heading,{level:`3`,id:`rate-limit-details`,children:`Rate Limit Details`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`HTTP Identify API`}),`: `,_jsx(_components.strong,{children:`600 requests per minute`}),` per application token`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`HTTP Track Events API`}),`: `,_jsx(_components.strong,{children:`600 requests per minute`}),` per application token`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsx(_components.p,{children:`When you exceed these limits, the API returns:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`429 Too Many Requests`})}),`: Returned when you exceed the 600 requests per minute limit`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`best-practices`,children:`Best Practices`}),`\n`,_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Implement Exponential Backoff`}),`: When you receive a 429 error, wait progressively longer before retrying (e.g., 1s, 2s, 4s, 8s).`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Monitor Your Usage`}),`: Track your request patterns to stay within limits and optimize your integration performance.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Handle Errors Gracefully`}),`: Always implement proper error handling for rate limit responses in your applications.`]})]})]})}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":"Overview","description":"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.","keywords":["Userpilot","API","user","company","event","tracking"],"href":"/api-references/real-time/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Rate Limits","slug":"rate-limits","depth":2,"children":[{"title":"Rate Limit Details","slug":"rate-limit-details","depth":3,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":3,"children":[]},{"title":"Best Practices","slug":"best-practices","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/userpilot/3ace2e9458eac66f/.prettierrc.js","/_mintlify/custom/userpilot/27d7e6557bc674e7/plausible.js","/_mintlify/custom/userpilot/222114e09e9d43ba/scripts/generate-kb-manifest.js","/_mintlify/custom/userpilot/7588c52f105b4ce6/scripts/check-nav.js","/_mintlify/custom/userpilot/77c4aabf1776912c/scripts/check-redirects.js","/_mintlify/custom/userpilot/c4efe6226e95d900/scripts/lib/docs-lib.js","/_mintlify/custom/userpilot/8278790c2c1428e5/scripts/precommit.js","/_mintlify/custom/userpilot/826df8c2727af7c1/scripts/seo-audit.js"],"subdomain":"userpilot","siteName":"Userpilot Knowledge Base","title":"Overview - Userpilot Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T09:23:46.263Z","originalFileLocation":"api-references/real-time/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=\"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userpilot.com/api-references/real-time/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\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=\"Overview - Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6765e8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userpilot.com/api-references/real-time/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/real-time/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userpilot.com/#organization\",\"name\":\"Userpilot Knowledge Base\",\"url\":\"https://docs.userpilot.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-dark.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=ed5988b05e17770537d7327506be349c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userpilot.com#website\",\"name\":\"Userpilot Knowledge Base\",\"url\":\"https://docs.userpilot.com\",\"publisher\":{\"@id\":\"https://docs.userpilot.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userpilot.com/api-references/real-time/overview#webpage\",\"url\":\"https://docs.userpilot.com/api-references/real-time/overview\",\"name\":\"Overview\",\"description\":\"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\",\"dateModified\":\"2026-01-28T09:23:46.263Z\",\"isPartOf\":{\"@id\":\"https://docs.userpilot.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userpilot.com/api-references/real-time/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userpilot.com/api-references/real-time/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Userpilot Knowledge Base\",\"item\":\"https://docs.userpilot.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.userpilot.com/api-references/real-time/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.userpilot.com/api-references/real-time/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Real-time HTTP APIs for user and company identification and event tracking in Userpilot.\",\"url\":\"https://docs.userpilot.com/api-references/real-time/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userpilot.com/api-references/real-time/overview#webpage\"},\"image\":\"https://docs.userpilot.com/up-logo-dark.svg\",\"dateModified\":\"2026-01-28T09:23:46.263Z\",\"keywords\":\"Userpilot, API, user, company, event, tracking\",\"publisher\":{\"@id\":\"https://docs.userpilot.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userpilot.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userpilot Knowledge Base\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Userpilot Knowledge Base","nav":{"global":null,"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":"/getting-started/what-is-userpilot"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Developer","pages":[{"title":"Developer","href":"/developer/installation/web"}]},{"tab":"APIs","groups":[{"group":"APIs","icon":"rectangle-terminal","pages":[{"title":"Userpilot API Documentation","sidebarTitle":"Overview","mode":"wide","href":"/api-references/overview"},{"title":"Authentication","href":"/api-references/authentication"},{"title":"Environment","description":"Userpilot APIs are available at different endpoint URLs depending on your hosting environment, with dedicated endpoints for Enterprise and EU customers.","href":"/api-references/environment"}]},{"group":"Real-time HTTP","pages":[{"title":"Overview","href":"/api-references/real-time/overview"},{"title":"Identify User","description":"The Identify User API allows you to create or update user profiles in real time, either individually or in bulk. Use this API to keep your user data in sync with Userpilot for analytics, segmentation, and personalized experiences.","href":"/api-references/real-time/identify-user"},{"title":"Identify Company","href":"/api-references/real-time/identify-company"},{"title":"Track Event","href":"/api-references/real-time/track-event"},{"group":"Endpoints","pages":[{"title":"Identify User","openapi":"POST /v1/identify","href":"/api-references/endpoints/realtime/identify-user"},{"title":"Identify Company","openapi":"POST /v1/companies/identify","href":"/api-references/endpoints/realtime/identify-company"},{"title":"Track Event","openapi":"POST /v1/track","href":"/api-references/endpoints/realtime/track-event"}]}]},{"group":"Bulk Identify/Update","pages":[{"title":"Bulk Identify/Update Users","sidebarTitle":"Users","href":"/api-references/bulk-updates/users"},{"title":"Bulk Identify/Update Companies","sidebarTitle":"Companies","href":"/api-references/bulk-updates/companies"},{"group":"Endpoints","pages":[{"title":"Bulk Users Update","sidebarTitle":"Users","openapi":"POST /v1/users/bulk_identify","href":"/api-references/endpoints/bulk/users"},{"title":"Bulk Companies Update","sidebarTitle":"Companies","openapi":"POST /v1/companies/bulk_identify","href":"/api-references/endpoints/bulk/companies"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Import","pages":[{"title":"Events Bulk Import","sidebarTitle":"Overview","href":"/api-references/import/overview"},{"title":"Event Schema","href":"/api-references/import/event-schema"},{"title":"Row Validation Rules","href":"/api-references/import/row-validation"},{"title":"User \u0026 Company Accumulative Properties Best Practices","sidebarTitle":"Best Practices","href":"/api-references/import/best-practices"},{"group":"Endpoints","pages":[{"title":"Import Job","openapi":"POST /v1/imports","href":"/api-references/endpoints/import/import-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Export","pages":[{"title":"Bulk Data Export API","sidebarTitle":"Overview","href":"/api-references/export/overview"},{"title":"Event Schema","sidebarTitle":"Event Schema","href":"/api-references/export/event-schema"},{"title":"Data Lookups","sidebarTitle":"Data Lookups","href":"/api-references/export/lookups"},{"group":"Endpoints","pages":[{"title":"Export Job","sidebarTitle":"Export Job","openapi":"POST /api/v1/analytics/exports","href":"/api-references/endpoints/export/export-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"},{"group":"Lookups","pages":[{"title":"User Properties","sidebarTitle":"User Properties","openapi":"GET /api/v1/analytics/exports/lookups/user_properties","href":"/api-references/endpoints/lookups/user-properties"},{"title":"Company Properties","sidebarTitle":"Company Properties","openapi":"GET /api/v1/analytics/exports/lookups/company_properties","href":"/api-references/endpoints/lookups/company-properties"},{"title":"Segments","sidebarTitle":"Segments","openapi":"GET /api/v1/analytics/exports/lookups/segments","href":"/api-references/endpoints/lookups/segments"},{"title":"Features \u0026 Events","sidebarTitle":"Features \u0026 Events","openapi":"GET /api/v1/analytics/exports/lookups/features_events","href":"/api-references/endpoints/lookups/features-events"},{"title":"Flows","sidebarTitle":"Flows","openapi":"GET /api/v1/analytics/exports/lookups/flows","href":"/api-references/endpoints/lookups/flows"},{"title":"Banners","sidebarTitle":"Banners","openapi":"GET /api/v1/analytics/exports/lookups/banners","href":"/api-references/endpoints/lookups/banners"},{"title":"Embeds","sidebarTitle":"Embeds","openapi":"GET /api/v1/analytics/exports/lookups/embeds","href":"/api-references/endpoints/lookups/embeds"},{"title":"Spotlights","sidebarTitle":"Spotlights","openapi":"GET /api/v1/analytics/exports/lookups/spotlights","href":"/api-references/endpoints/lookups/spotlights"},{"title":"Checklists","sidebarTitle":"Checklists","openapi":"GET /api/v1/analytics/exports/lookups/checklists","href":"/api-references/endpoints/lookups/checklists"},{"title":"Surveys","sidebarTitle":"Surveys","openapi":"GET /api/v1/analytics/exports/lookups/surveys","href":"/api-references/endpoints/lookups/surveys"},{"title":"Resource Center Modules","sidebarTitle":"Resource Center Modules","openapi":"GET /api/v1/analytics/exports/lookups/resource_center_modules","href":"/api-references/endpoints/lookups/resource-center-modules"}]}]}]},{"group":"Email Subscriptions","pages":[{"title":"List Subscription Topics","href":"/api-references/email-subscriptions/list-topics"},{"title":"Set Subscription Preferences","href":"/api-references/email-subscriptions/set-preferences"}]},{"group":"Bulk Delete","pages":[{"title":"Delete Users and Companies","sidebarTitle":"Overview","href":"/api-references/delete/overview"}]}]}]},"basePath":"","title":"Overview - Userpilot Knowledge Base","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}