> ## Documentation Index
> Fetch the complete documentation index at: https://rollout.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List User Activity Metrics

> 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).



## OpenAPI

````yaml /openapi/crm.json get /user-activity-metrics
openapi: 3.1.2
info:
  title: Universal CRM API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://crm.universal.rollout.com/api
security: []
paths:
  /user-activity-metrics:
    get:
      tags:
        - User Activity Metrics
      summary: 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).
      operationId: getUser-activity-metrics
      parameters:
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
              - periodStart
        - name: id
          in: query
          required: false
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
        - name: activityType
          in: query
          required: false
          schema:
            type: string
        - name: periodStart.gte
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: periodStart.lte
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: rolloutUpdated.gte
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.lte
          in: query
          required: false
          schema:
            type: string
        - name: next
          in: query
          required: false
          schema:
            type: string
            description: >-
              Cursor of the page to return, from the previous page's
              `_metadata.next`. Can't be combined with `offset`.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            description: >-
              Number of records to skip, for offset paging. Defaults to 0. Can't
              be combined with `next`.
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            description: Records per page, capped at 100.
            type: number
        - 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.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    type: object
                    properties:
                      collection:
                        type: string
                        const: userActivityMetrics
                        description: The key of this response that holds the records.
                      offset:
                        type: number
                        description: >-
                          Number of records skipped before this page: the
                          `offset` requested, or 0 on a cursor page.
                      limit:
                        type: number
                        description: >-
                          Page size applied: the `limit` requested, capped at
                          100, or 10 by default.
                      total:
                        type: number
                        description: >-
                          Number of records matching the request, across all
                          pages.
                      next:
                        description: >-
                          Cursor of the next page, to pass as `next`; null on
                          the last page.
                        type:
                          - string
                          - 'null'
                      nextLink:
                        description: >-
                          URL of the next page, this request's with `next` set;
                          null on the last page.
                        type:
                          - string
                          - 'null'
                    required:
                      - collection
                      - offset
                      - limit
                      - total
                      - next
                      - nextLink
                    description: How this page relates to the whole collection.
                  userActivityMetrics:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        userId:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        periodStart:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                          format: date
                        periodEnd:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                          format: date
                        activityType:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        activityTypeName:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        value:
                          description: Present unless the request's `fields` leaves it out.
                          type: number
                        unit:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                          enum:
                            - count
                            - minutes
                            - hours
                        breakdown:
                          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
                            - 'null'
                          items:
                            type: object
                            properties:
                              transactionId:
                                type:
                                  - string
                                  - 'null'
                              personId:
                                type:
                                  - string
                                  - 'null'
                              value:
                                type: number
                            required:
                              - transactionId
                              - personId
                              - value
                        created:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        updated:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        rolloutUpdated:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                          format: date-time
                        originalIds:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type:
                              - number
                              - string
                        original:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                      required:
                        - id
                    description: The records of this page, under the collection's name.
                required:
                  - _metadata
                  - userActivityMetrics
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.