The Rollout Credential ID to use for queries/mutations
Path Parameters
id
string
required
Query Parameters
fields
string
Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.
Response
Response for status 200
id
string
required
userId
string | null
Present unless the request's fields leaves it out.
periodStart
string<date>
Present unless the request's fields leaves it out.
periodEnd
string<date>
Present unless the request's fields leaves it out.
activityType
string
Present unless the request's fields leaves it out.
activityTypeName
string
Present unless the request's fields leaves it out.
value
number
Present unless the request's fields leaves it out.
unit
enum<string>
Present unless the request's fields leaves it out.
Available options:
count,
minutes,
hours
breakdown
object[] | null
How much of value was for each deal, and the contact on it, in unit. A split of value, never added to it: what the entries leave is the activity the source didn't link to a deal. An id is null when that deal or contact isn't synced, and the entry keeps its value. [] when the source can link activity to deals and linked none; null when it can't link this activity to deals at all. Only Sisu fills it today; every other app returns [] for now, which doesn't mean its activity was unlinked. Present unless the request's fields leaves it out.
Show child attributes
created
string<date-time> | null
Present unless the request's fields leaves it out.
updated
string<date-time> | null
Present unless the request's fields leaves it out.
rolloutUpdated
string<date-time>
Present unless the request's fields leaves it out.
originalIds
object
Present unless the request's fields leaves it out.
Show child attributes
original
object
Present unless the request's fields leaves it out.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rollout","colors":{"primary":"#5f57ff","light":"#7c75ff","dark":"#4a43d9"},"logo":{"light":"https://mintcdn.com/rollout/J3SgtcePtApyhjtP/logo/light.svg?fit=max\u0026auto=format\u0026n=J3SgtcePtApyhjtP\u0026q=85\u0026s=00986eb1db3eecac84e49814b4ba2d43","dark":"https://mintcdn.com/rollout/J3SgtcePtApyhjtP/logo/dark.svg?fit=max\u0026auto=format\u0026n=J3SgtcePtApyhjtP\u0026q=85\u0026s=4ac30390bf2859d2e80a9ef0964e859f"},"favicon":"https://mintcdn.com/rollout/J3SgtcePtApyhjtP/favicon.png?fit=max\u0026auto=format\u0026n=J3SgtcePtApyhjtP\u0026q=85\u0026s=f6ddc5b83a06300ac764765d798998c1","navbar":{"links":[{"href":"mailto:support@rollout.com","label":"Support"}],"primary":{"type":"button","label":"Request Access","href":"/contact"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rollout","hasAudioNarration":false,"actualSubdomain":"rollout","customDomains":["rollout.com"],"gitSource":{"type":"github","owner":"rollouthq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6affc68fd789b64a2bf9f38e","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":296},{"language":"default","tag":"Real Estate CRM API","count":132},{"language":"default","tag":"CRM Reference","count":132},{"language":"default","tag":"TMS API","count":70},{"language":"default","tag":"TMS Reference","count":70},{"language":"default","tag":"Authentication Guides","count":51},{"language":"default","tag":"Developer Guides","count":43},{"language":"default","tag":"LOS API","count":40},{"language":"default","tag":"LOS Reference","count":40},{"language":"default","tag":"Mortgage CRM API","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"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":"editor-metadata","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".update-container [data-component-part=\"update-tag-list\"]{margin-top:0.65rem;padding-left:0;gap:0.45rem}.update-container [data-component-part=\"update-tag\"]{display:inline-flex;align-items:center;padding:0.2rem 0.55rem;border-radius:9999px;border:1px solid rgba(95, 87, 255, 0.22);background:rgba(95, 87, 255, 0.1);color:#4a43d9;font-size:0.75rem;font-weight:600;line-height:1.25;letter-spacing:0.01em}.dark .update-container [data-component-part=\"update-tag\"]{border-color:rgba(124, 117, 255, 0.4);background:rgba(124, 117, 255, 0.18);color:#d6d4ff}"}]}
{"page":{"pagePath":"api-reference/crm/user-activity-metrics/get-user-activity-metric","slug":"/api-reference/crm/user-activity-metrics/get-user-activity-metric","pageMetadata":{"title":"Get User Activity Metric","description":"Requires `userActivityMetrics: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /user-activity-metrics/{id}","href":"/api-reference/crm/user-activity-metrics/get-user-activity-metric","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requires \", _jsx(_components.code, {\n children: \"userActivityMetrics: true\"\n }), \" in the credential’s \", _jsx(_components.code, {\n children: \"entitiesToSync\"\n }), \" selection and a connector that supports this operation. \", _jsx(_components.a, {\n href: \"https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout\",\n children: \"Choose what data to sync\"\n }), \", or \", _jsx(_components.a, {\n href: \"https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync\",\n children: \"fix an entity that is not configured to sync\"\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 User Activity Metric","description":"Requires `userActivityMetrics: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /user-activity-metrics/{id}","href":"/api-reference/crm/user-activity-metrics/get-user-activity-metric","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["User Activity Metrics"],"security":["ac6a89c4-0a86-4f52-ab0a-ff82b5ee8e64"],"description":"Requires `userActivityMetrics: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).","summary":"Get User Activity Metric","parameters":["a3cf25fc-5a68-461a-bb7f-be7b74569047","9fc0417b-9718-4a16-a385-f79189c04e18"],"responses":{"200":"046d0288-5f8c-4062-9e08-34a990329507","400":"fa755565-a350-4c31-84e1-0e4c6dea7276","404":"9c204ef3-6c39-414f-8ea0-ece4b81a3e96"},"operationId":"getUser-activity-metricsById","method":"get","type":"path","servers":["7b2f9b1a-4571-43ba-a495-3d9e80ec677e"],"path":"/user-activity-metrics/{id}","baseUrlOptions":["https://crm.universal.rollout.com/api"],"title":"Get User Activity Metric","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a3cf25fc-5a68-461a-bb7f-be7b74569047":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"9fc0417b-9718-4a16-a385-f79189c04e18":{"name":"fields","in":"query","required":false,"schema":{"type":"string","description":"Comma-separated top-level fields to return; the parameter can also be repeated, once per field. `id` is always returned. Omit it, or pass `allFields`, to get every field, including `original`. Unknown names return 400.","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"responses":{"046d0288-5f8c-4062-9e08-34a990329507":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"userId":{"oneOf":[{"description":"Present unless the request's `fields` leaves it out.","type":"string","uniqueKey":"userId.oneOf.0","typeLabel":"string"},{"description":"Present unless the request's `fields` leaves it out.","type":"null","uniqueKey":"userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"userId","typeLabel":"string | null"},"periodStart":{"description":"Present unless the request's `fields` leaves it out.","type":"string","format":"date","uniqueKey":"periodStart","typeLabel":"string\u003cdate>"},"periodEnd":{"description":"Present unless the request's `fields` leaves it out.","type":"string","format":"date","uniqueKey":"periodEnd","typeLabel":"string\u003cdate>"},"activityType":{"description":"Present unless the request's `fields` leaves it out.","type":"string","uniqueKey":"activityType","typeLabel":"string"},"activityTypeName":{"description":"Present unless the request's `fields` leaves it out.","type":"string","uniqueKey":"activityTypeName","typeLabel":"string"},"value":{"description":"Present unless the request's `fields` leaves it out.","type":"number","uniqueKey":"value","typeLabel":"number"},"unit":{"description":"Present unless the request's `fields` leaves it out.","type":"string","enum":["count","minutes","hours"],"uniqueKey":"unit","typeLabel":"enum\u003cstring>"},"breakdown":{"oneOf":[{"description":"How much of `value` was for each deal, and the contact on it, in `unit`. A split of `value`, never added to it: what the entries leave is the activity the source didn't link to a deal. An id is `null` when that deal or contact isn't synced, and the entry keeps its value. `[]` when the source can link activity to deals and linked none; `null` when it can't link this activity to deals at all. Only Sisu fills it today; every other app returns `[]` for now, which doesn't mean its activity was unlinked. Present unless the request's `fields` leaves it out.","type":"array","items":{"type":"object","properties":{"transactionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].transactionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].transactionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].transactionId","typeLabel":"string | null"},"personId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].personId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].personId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].personId","typeLabel":"string | null"},"value":{"type":"number","isRequired":true,"uniqueKey":"breakdown.oneOf.0.items.[INDEX].value","typeLabel":"number"}},"required":["transactionId","personId","value"],"uniqueKey":"breakdown.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"breakdown.oneOf.0","typeLabel":"object[]"},{"description":"How much of `value` was for each deal, and the contact on it, in `unit`. A split of `value`, never added to it: what the entries leave is the activity the source didn't link to a deal. An id is `null` when that deal or contact isn't synced, and the entry keeps its value. `[]` when the source can link activity to deals and linked none; `null` when it can't link this activity to deals at all. Only Sisu fills it today; every other app returns `[]` for now, which doesn't mean its activity was unlinked. Present unless the request's `fields` leaves it out.","type":"null","items":{"type":"object","properties":{"transactionId":{"oneOf":[{"type":"string"},{"type":"null"}]},"personId":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"type":"number"}},"required":["transactionId","personId","value"]},"uniqueKey":"breakdown.oneOf.1","typeLabel":"null"}],"uniqueKey":"breakdown","typeLabel":"object[] | null"},"created":{"oneOf":[{"description":"Present unless the request's `fields` leaves it out.","type":"string","format":"date-time","uniqueKey":"created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Present unless the request's `fields` leaves it out.","type":"null","format":"date-time","uniqueKey":"created.oneOf.1","typeLabel":"null"}],"uniqueKey":"created","typeLabel":"string\u003cdate-time> | null"},"updated":{"oneOf":[{"description":"Present unless the request's `fields` leaves it out.","type":"string","format":"date-time","uniqueKey":"updated.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Present unless the request's `fields` leaves it out.","type":"null","format":"date-time","uniqueKey":"updated.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated","typeLabel":"string\u003cdate-time> | null"},"rolloutUpdated":{"description":"Present unless the request's `fields` leaves it out.","type":"string","format":"date-time","uniqueKey":"rolloutUpdated","typeLabel":"string\u003cdate-time>"},"originalIds":{"description":"Present unless the request's `fields` leaves it out.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"originalIds.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"originalIds.additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"originalIds.additionalProperties","typeLabel":"number | string"},"uniqueKey":"originalIds","typeLabel":"object"},"original":{"description":"Present unless the request's `fields` leaves it out.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"original.additionalProperties.additionalProperties","typeLabel":"any"},"uniqueKey":"original.additionalProperties","typeLabel":"object"},"uniqueKey":"original","typeLabel":"object"}},"required":["id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","userId":"\u003cstring>","periodStart":"2023-12-25","periodEnd":"2023-12-25","activityType":"\u003cstring>","activityTypeName":"\u003cstring>","value":123,"unit":"count","breakdown":[{"transactionId":"\u003cstring>","personId":"\u003cstring>","value":123}],"created":"2023-11-07T05:31:56Z","updated":"2023-11-07T05:31:56Z","rolloutUpdated":"2023-11-07T05:31:56Z","originalIds":{},"original":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"fa755565-a350-4c31-84e1-0e4c6dea7276":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"type":"string","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"required":["errorMessage"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c204ef3-6c39-414f-8ea0-ece4b81a3e96":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","const":"RESOURCE_NOT_FOUND","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errorMessage":{"type":"string","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"}},"required":["code","errorMessage"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"RESOURCE_NOT_FOUND","errorMessage":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ac6a89c4-0a86-4f52-ab0a-ff82b5ee8e64":{"jwt":{"type":"http","scheme":"bearer","description":"Consumer JWT minted by the tenant's backend","scopes":[],"schemeName":"jwt"},"credential_id":{"type":"apiKey","in":"header","name":"X-Rollout-Credential-Id","description":"The Rollout Credential ID to use for queries/mutations","scopes":[],"schemeName":"credential_id"}}},"servers":{"7b2f9b1a-4571-43ba-a495-3d9e80ec677e":{"url":"https://crm.universal.rollout.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Consumer JWT minted by the tenant's backend","scopes":[],"schemeName":"jwt"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Consumer JWT minted by the tenant's backend","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"jwt","name":"Authorization"},{"scheme":{"type":"apiKey","in":"header","name":"X-Rollout-Credential-Id","description":"The Rollout Credential ID to use for queries/mutations","scopes":[],"schemeName":"credential_id"},"schema":{"title":"X-Rollout-Credential-Id","type":"string","description":"The Rollout Credential ID to use for queries/mutations","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"credential_id","name":"X-Rollout-Credential-Id"}],"title":"jwt \u0026 credential_id"}]},"originalFileLocation":"openapi/crm.json"},"subdomain":"rollout","siteName":"Rollout","title":"Get User Activity Metric - Rollout","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T06:06:35.738Z","originalFileLocation":"api-reference/crm/user-activity-metrics/get-user-activity-metric.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=\"Requires userActivityMetrics: true in the credential\u0026#x27;s entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rollout\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_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=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get User Activity Metric - Rollout\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires userActivityMetrics: true in the credential\u0026#x27;s entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rollout\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rollout.mintlify.site/docs/_mintlify/api/og/v2?division=User+Activity+Metrics\u0026amp;title=Get+User+Activity+Metric\u0026amp;description=Requires+%60userActivityMetrics%3A+true%60+in+the+credential%27s+%60entitiesToSync%60+selection+and+a+connector+that+supports+this+operation.+%5BChoose+what+data+to+sync%5D%28htt\u0026amp;theme=433537959f5aec062fb9d919\u0026amp;signature=0a537f49b4557906b7c0bbb5d696ba2ab8cbd5f927dbc892aa15e66f7545d614\">\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 User Activity Metric - Rollout\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires userActivityMetrics: true in the credential\u0026#x27;s entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rollout.mintlify.site/docs/_mintlify/api/og/v2?division=User+Activity+Metrics\u0026amp;title=Get+User+Activity+Metric\u0026amp;description=Requires+%60userActivityMetrics%3A+true%60+in+the+credential%27s+%60entitiesToSync%60+selection+and+a+connector+that+supports+this+operation.+%5BChoose+what+data+to+sync%5D%28htt\u0026amp;theme=433537959f5aec062fb9d919\u0026amp;signature=0a537f49b4557906b7c0bbb5d696ba2ab8cbd5f927dbc892aa15e66f7545d614\">\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=\"/docs/mintlify-assets/_mintlify/favicons/rollout/A5o2RojWP47K4REB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rollout\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5f57ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://rollout.com/#organization\",\"name\":\"Rollout\",\"url\":\"https://rollout.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rollout/J3SgtcePtApyhjtP/logo/light.svg?fit=max\u0026auto=format\u0026n=J3SgtcePtApyhjtP\u0026q=85\u0026s=00986eb1db3eecac84e49814b4ba2d43\"}},{\"@type\":\"WebSite\",\"@id\":\"https://rollout.com/docs#website\",\"name\":\"Rollout\",\"url\":\"https://rollout.com/docs\",\"publisher\":{\"@id\":\"https://rollout.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric#webpage\",\"url\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric\",\"name\":\"Get User Activity Metric\",\"description\":\"Requires userActivityMetrics: true in the credential's entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.\",\"dateModified\":\"2026-11-18T06:06:35.738Z\",\"isPartOf\":{\"@id\":\"https://rollout.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CRM Reference\",\"item\":\"https://rollout.com/docs/api-reference/crm/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://rollout.com/docs/api-reference/crm/people/list-people\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"User Activity Metrics\",\"item\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/list-user-activity-metrics\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get User Activity Metric\",\"item\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric#apireference\",\"headline\":\"Get User Activity Metric\",\"name\":\"Get User Activity Metric\",\"description\":\"Requires userActivityMetrics: true in the credential's entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.\",\"url\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric\",\"mainEntityOfPage\":{\"@id\":\"https://rollout.com/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric#webpage\"},\"dateModified\":\"2026-11-18T06:06:35.738Z\",\"publisher\":{\"@id\":\"https://rollout.com/#organization\"},\"isPartOf\":{\"@id\":\"https://rollout.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rollout\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Rollout\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/crm/user-activity-metrics/get-user-activity-metric.md","siteName":"Rollout","nav":{"global":null,"tabs":[{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":""}]},{"tab":"Authentication Guides","pages":[{"title":"Authentication Guides","href":"/end-user-guides/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Real Estate CRM API","groups":[{"group":"CRM Reference","pages":[{"title":"CRM API Overview","href":"/api-reference/crm/overview"},{"title":"Authentication","href":"/api-reference/crm/authentication"},{"title":"Pagination","href":"/api-reference/crm/pagination"},{"title":"Errors","href":"/api-reference/crm/errors"},{"group":"Endpoints","expanded":true,"pages":[{"group":"People","expanded":true,"pages":[{"title":"List People","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /people","href":"/api-reference/crm/people/list-people"},{"title":"Create Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /people","href":"/api-reference/crm/people/create-person"},{"title":"Get Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /people/{id}","href":"/api-reference/crm/people/get-person"},{"title":"Update Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /people/{id}","href":"/api-reference/crm/people/update-person"},{"title":"Delete Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /people/{id}","href":"/api-reference/crm/people/delete-person"},{"title":"Apply Tags to Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /people/{id}/tags/apply","href":"/api-reference/crm/people/apply-tags-to-person"},{"title":"Remove Tags from Person","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /people/{id}/tags/delete","href":"/api-reference/crm/people/remove-tags-from-person"}]},{"group":"People Relationships","expanded":true,"pages":[{"title":"List People Relationships","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /people-relationships","href":"/api-reference/crm/people-relationships/list-people-relationships"},{"title":"Get People Relationship","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /people-relationships/{id}","href":"/api-reference/crm/people-relationships/get-people-relationship"},{"title":"Update People Relationship","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /people-relationships/{id}","href":"/api-reference/crm/people-relationships/update-people-relationship"}]},{"group":"Notes","expanded":true,"pages":[{"title":"List Notes","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /notes","href":"/api-reference/crm/notes/list-notes"},{"title":"Create Note","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /notes","href":"/api-reference/crm/notes/create-note"},{"title":"Get Note","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /notes/{id}","href":"/api-reference/crm/notes/get-note"},{"title":"Update Note","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /notes/{id}","href":"/api-reference/crm/notes/update-note"},{"title":"Delete Note","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /notes/{id}","href":"/api-reference/crm/notes/delete-note"}]},{"group":"Stages","expanded":true,"pages":[{"title":"List Stages","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /stages","href":"/api-reference/crm/stages/list-stages"},{"title":"Create Stage","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /stages","href":"/api-reference/crm/stages/create-stage"},{"title":"Get Stage","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /stages/{id}","href":"/api-reference/crm/stages/get-stage"},{"title":"Update Stage","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /stages/{id}","href":"/api-reference/crm/stages/update-stage"},{"title":"Delete Stage","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /stages/{id}","href":"/api-reference/crm/stages/delete-stage"}]},{"group":"Pipelines","expanded":true,"pages":[{"title":"List Pipelines","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /pipelines","href":"/api-reference/crm/pipelines/list-pipelines"},{"title":"Get Pipeline","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /pipelines/{id}","href":"/api-reference/crm/pipelines/get-pipeline"}]},{"group":"Users","expanded":true,"pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /users","href":"/api-reference/crm/users/list-users"},{"title":"Create User","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /users","href":"/api-reference/crm/users/create-user"},{"title":"Get User","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /users/{id}","href":"/api-reference/crm/users/get-user"},{"title":"Update User","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /users/{id}","href":"/api-reference/crm/users/update-user"},{"title":"Delete User","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /users/{id}","href":"/api-reference/crm/users/delete-user"}]},{"group":"Tasks","expanded":true,"pages":[{"title":"List Tasks","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /tasks","href":"/api-reference/crm/tasks/list-tasks"},{"title":"Create Task","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /tasks","href":"/api-reference/crm/tasks/create-task"},{"title":"Get Task","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /tasks/{id}","href":"/api-reference/crm/tasks/get-task"},{"title":"Update Task","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /tasks/{id}","href":"/api-reference/crm/tasks/update-task"},{"title":"Delete Task","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /tasks/{id}","href":"/api-reference/crm/tasks/delete-task"}]},{"group":"Smart Lists","expanded":true,"pages":[{"title":"List Smart Lists","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /smart-lists","href":"/api-reference/crm/smart-lists/list-smart-lists"},{"title":"Create Smart List","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /smart-lists","href":"/api-reference/crm/smart-lists/create-smart-list"},{"title":"Get Smart List","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /smart-lists/{id}","href":"/api-reference/crm/smart-lists/get-smart-list"},{"title":"Update Smart List","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /smart-lists/{id}","href":"/api-reference/crm/smart-lists/update-smart-list"},{"title":"Delete Smart List","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /smart-lists/{id}","href":"/api-reference/crm/smart-lists/delete-smart-list"}]},{"group":"Calls","expanded":true,"pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /calls","href":"/api-reference/crm/calls/list-calls"},{"title":"Create Call","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /calls","href":"/api-reference/crm/calls/create-call"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /calls/{id}","href":"/api-reference/crm/calls/get-call"},{"title":"Update Call","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /calls/{id}","href":"/api-reference/crm/calls/update-call"},{"title":"Delete Call","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /calls/{id}","href":"/api-reference/crm/calls/delete-call"}]},{"group":"Teams","expanded":true,"pages":[{"title":"List Teams","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /teams","href":"/api-reference/crm/teams/list-teams"},{"title":"Create Team","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /teams","href":"/api-reference/crm/teams/create-team"},{"title":"Get Team","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /teams/{id}","href":"/api-reference/crm/teams/get-team"},{"title":"Update Team","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /teams/{id}","href":"/api-reference/crm/teams/update-team"},{"title":"Delete Team","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /teams/{id}","href":"/api-reference/crm/teams/delete-team"}]},{"group":"Text Messages","expanded":true,"pages":[{"title":"List Text Messages","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /textMessages","href":"/api-reference/crm/text-messages/list-text-messages"},{"title":"Create Text Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /textMessages","href":"/api-reference/crm/text-messages/create-text-message"},{"title":"Get Text Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /textMessages/{id}","href":"/api-reference/crm/text-messages/get-text-message"},{"title":"Update Text Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /textMessages/{id}","href":"/api-reference/crm/text-messages/update-text-message"},{"title":"Delete Text Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /textMessages/{id}","href":"/api-reference/crm/text-messages/delete-text-message"}]},{"group":"Email Messages","expanded":true,"pages":[{"title":"List Email Messages","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /emailMessages","href":"/api-reference/crm/email-messages/list-email-messages"},{"title":"Create Email Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /emailMessages","href":"/api-reference/crm/email-messages/create-email-message"},{"title":"Get Email Message","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /emailMessages/{id}","href":"/api-reference/crm/email-messages/get-email-message"}]},{"group":"Appointments","expanded":true,"pages":[{"title":"List Appointments","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointments","href":"/api-reference/crm/appointments/list-appointments"},{"title":"Create Appointment","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /appointments","href":"/api-reference/crm/appointments/create-appointment"},{"title":"Get Appointment","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointments/{id}","href":"/api-reference/crm/appointments/get-appointment"},{"title":"Update Appointment","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /appointments/{id}","href":"/api-reference/crm/appointments/update-appointment"},{"title":"Delete Appointment","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /appointments/{id}","href":"/api-reference/crm/appointments/delete-appointment"}]},{"group":"Appointment Types","expanded":true,"pages":[{"title":"List Appointment Types","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointment-types","href":"/api-reference/crm/appointment-types/list-appointment-types"},{"title":"Create Appointment Type","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /appointment-types","href":"/api-reference/crm/appointment-types/create-appointment-type"},{"title":"Get Appointment Type","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointment-types/{id}","href":"/api-reference/crm/appointment-types/get-appointment-type"},{"title":"Update Appointment Type","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /appointment-types/{id}","href":"/api-reference/crm/appointment-types/update-appointment-type"},{"title":"Delete Appointment Type","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /appointment-types/{id}","href":"/api-reference/crm/appointment-types/delete-appointment-type"}]},{"group":"Appointment Outcomes","expanded":true,"pages":[{"title":"List Appointment Outcomes","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointment-outcomes","href":"/api-reference/crm/appointment-outcomes/list-appointment-outcomes"},{"title":"Create Appointment Outcome","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /appointment-outcomes","href":"/api-reference/crm/appointment-outcomes/create-appointment-outcome"},{"title":"Get Appointment Outcome","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /appointment-outcomes/{id}","href":"/api-reference/crm/appointment-outcomes/get-appointment-outcome"},{"title":"Update Appointment Outcome","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /appointment-outcomes/{id}","href":"/api-reference/crm/appointment-outcomes/update-appointment-outcome"},{"title":"Delete Appointment Outcome","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /appointment-outcomes/{id}","href":"/api-reference/crm/appointment-outcomes/delete-appointment-outcome"}]},{"group":"Lists","expanded":true,"pages":[{"title":"List Lists","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /lists","href":"/api-reference/crm/lists/list-lists"},{"title":"Create List","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /lists","href":"/api-reference/crm/lists/create-list"},{"title":"Get List","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /lists/{id}","href":"/api-reference/crm/lists/get-list"},{"title":"Update List","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /lists/{id}","href":"/api-reference/crm/lists/update-list"},{"title":"Delete List","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /lists/{id}","href":"/api-reference/crm/lists/delete-list"},{"title":"Add People to List","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /lists/{id}/people","href":"/api-reference/crm/lists/add-people-to-list"},{"title":"Remove People from List","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /lists/{id}/people","href":"/api-reference/crm/lists/remove-people-from-list"}]},{"group":"Custom Fields","expanded":true,"pages":[{"title":"List Custom Fields","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /customFields","href":"/api-reference/crm/custom-fields/list-custom-fields"},{"title":"Create Custom Field","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /customFields","href":"/api-reference/crm/custom-fields/create-custom-field"},{"title":"Get Custom Field","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /customFields/{id}","href":"/api-reference/crm/custom-fields/get-custom-field"},{"title":"Update Custom Field","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /customFields/{id}","href":"/api-reference/crm/custom-fields/update-custom-field"},{"title":"Delete Custom Field","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /customFields/{id}","href":"/api-reference/crm/custom-fields/delete-custom-field"}]},{"group":"Events","expanded":true,"pages":[{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /events","href":"/api-reference/crm/events/list-events"},{"title":"Create Event","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /events","href":"/api-reference/crm/events/create-event"},{"title":"Get Event","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /events/{id}","href":"/api-reference/crm/events/get-event"},{"title":"Update Event","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /events/{id}","href":"/api-reference/crm/events/update-event"},{"title":"Delete Event","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /events/{id}","href":"/api-reference/crm/events/delete-event"}]},{"group":"Email Marketing Events","expanded":true,"pages":[{"title":"List Email Marketing Events","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /emEvents","href":"/api-reference/crm/email-marketing-events/list-email-marketing-events"},{"title":"Get Email Marketing Event","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /emEvents/{id}","href":"/api-reference/crm/email-marketing-events/get-email-marketing-event"}]},{"group":"Metadata","expanded":true,"pages":[{"title":"Get Metadata for Creating Transactions","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /metadata/transactions/create","href":"/api-reference/crm/metadata/get-metadata-for-creating-transactions"}]},{"group":"Sources","expanded":true,"pages":[{"title":"List Sources","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /sources","href":"/api-reference/crm/sources/list-sources"},{"title":"Create Source","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /sources","href":"/api-reference/crm/sources/create-source"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /sources/{id}","href":"/api-reference/crm/sources/get-source"},{"title":"Update Source","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /sources/{id}","href":"/api-reference/crm/sources/update-source"},{"title":"Delete Source","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /sources/{id}","href":"/api-reference/crm/sources/delete-source"}]},{"group":"Tags","expanded":true,"pages":[{"title":"List Tags","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /tags","href":"/api-reference/crm/tags/list-tags"}]},{"group":"Timeframes","expanded":true,"pages":[{"title":"List Timeframes","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /timeframes","href":"/api-reference/crm/timeframes/list-timeframes"},{"title":"Create Timeframe","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /timeframes","href":"/api-reference/crm/timeframes/create-timeframe"},{"title":"Get Timeframe","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /timeframes/{id}","href":"/api-reference/crm/timeframes/get-timeframe"},{"title":"Update Timeframe","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /timeframes/{id}","href":"/api-reference/crm/timeframes/update-timeframe"},{"title":"Delete Timeframe","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /timeframes/{id}","href":"/api-reference/crm/timeframes/delete-timeframe"}]},{"group":"Webhooks","expanded":true,"pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /webhooks","href":"/api-reference/crm/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /webhooks","href":"/api-reference/crm/webhooks/create-webhook"},{"title":"Get Webhook","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /webhooks/{id}","href":"/api-reference/crm/webhooks/get-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /webhooks/{id}","href":"/api-reference/crm/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /webhooks/{id}","href":"/api-reference/crm/webhooks/delete-webhook"}]},{"group":"Ponds","expanded":true,"pages":[{"title":"List Ponds","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /ponds","href":"/api-reference/crm/ponds/list-ponds"},{"title":"Create Pond","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /ponds","href":"/api-reference/crm/ponds/create-pond"},{"title":"Get Pond","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /ponds/{id}","href":"/api-reference/crm/ponds/get-pond"},{"title":"Update Pond","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /ponds/{id}","href":"/api-reference/crm/ponds/update-pond"},{"title":"Delete Pond","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /ponds/{id}","href":"/api-reference/crm/ponds/delete-pond"}]},{"group":"Properties","expanded":true,"pages":[{"title":"List Properties","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /properties","href":"/api-reference/crm/properties/list-properties"},{"title":"Create Property","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /properties","href":"/api-reference/crm/properties/create-property"},{"title":"Get Property","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /properties/{id}","href":"/api-reference/crm/properties/get-property"},{"title":"Update Property","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /properties/{id}","href":"/api-reference/crm/properties/update-property"}]},{"group":"Batch Actions","expanded":true,"pages":[{"title":"List Batch Action Jobs","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /actions/batchActionJobs","href":"/api-reference/crm/batch-actions/list-batch-action-jobs"},{"title":"Get Batch Action","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /actions/{id}","href":"/api-reference/crm/batch-actions/get-batch-action"},{"title":"Assign User to People","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /actions/assignUser","href":"/api-reference/crm/batch-actions/assign-user-to-people"},{"title":"Add Tags to People","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /actions/addTags","href":"/api-reference/crm/batch-actions/add-tags-to-people"},{"title":"Assign People to Pond","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /actions/assignToPond","href":"/api-reference/crm/batch-actions/assign-people-to-pond"},{"title":"Remove Tags from People","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /actions/removeTags","href":"/api-reference/crm/batch-actions/remove-tags-from-people"}]},{"group":"Offices","expanded":true,"pages":[{"title":"List Offices","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /offices","href":"/api-reference/crm/offices/list-offices"},{"title":"Create Office","deprecated":null,"version":null,"openapi":"/openapi/crm.json post /offices","href":"/api-reference/crm/offices/create-office"},{"title":"Get Office","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /offices/{id}","href":"/api-reference/crm/offices/get-office"},{"title":"Update Office","deprecated":null,"version":null,"openapi":"/openapi/crm.json put /offices/{id}","href":"/api-reference/crm/offices/update-office"},{"title":"Delete Office","deprecated":null,"version":null,"openapi":"/openapi/crm.json delete /offices/{id}","href":"/api-reference/crm/offices/delete-office"}]},{"group":"User Activity Metrics","expanded":true,"pages":[{"title":"List User Activity Metrics","description":"Requires `userActivityMetrics: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /user-activity-metrics","href":"/api-reference/crm/user-activity-metrics/list-user-activity-metrics"},{"title":"Get User Activity Metric","deprecated":null,"version":null,"openapi":"/openapi/crm.json get /user-activity-metrics/{id}","href":"/api-reference/crm/user-activity-metrics/get-user-activity-metric"}]}]}]}]},{"tab":"Mortgage CRM API","pages":[{"title":"Mortgage CRM API","href":"/api-reference/mortgage-crm/overview"}]},{"tab":"TMS API","pages":[{"title":"TMS API","href":"/api-reference/tms/overview"}]},{"tab":"LOS API","pages":[{"title":"LOS API","href":"/api-reference/los/overview"}]},{"tab":"Email API","pages":[{"title":"Email API","href":"/api-reference/email/overview"}]},{"tab":"Calendar API","pages":[{"title":"Calendar API","href":"/api-reference/calendar/overview"}]},{"tab":"Rollout API","pages":[{"title":"Rollout API","href":"/api-reference/rollout/overview"}]}]},"basePath":"","title":"Get User Activity Metric - Rollout","deploymentId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","buildId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DyP0AOE1.js","snippetPresets-CuYPAUIG.js","utils-ez5j6NBT.js","style-to-object-BY3JEAdk.js","utils-DG4aeUOF.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DFhcMUrP.js","conditional-requirements-CFM0id0Q.js","cloneDeep-ByDTqllG.js","_Uint8Array-CJ2WjX_H.js","isObject-FP1Yky1u.js","ApiExamples-fyn9sMD9.js","usePlaygroundInputsStore-Bf0N_Y6L.js","shallow-CnU26VTn.js","isEqual-OWIKZzop.js","CodeSnippets-CZ9-M31v.js","CodeSnippet-CCk6UVRR.js","getApiPlaygroundDisplay-BUw5JwZB.js","Page-CInwEL5w.js","DynamicMarkdown-CU5QIokU.js","SectionHeading-BoT1NwPU.js","icon-MsvNhD56.js","MethodPill-CC7p0-fp.js","getPastedJson-BOWYR2ND.js","DuplicateIcon-DOWJyC1b.js","createIcon-BsNyCaLY.js","axios-CsQoIw0U.js","Markdown-L0uigQE0.js","AssistantPageLink-Cur5OU4v.js","dist-CLdzWocy.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}