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

# Listar métricas de usuário

> Devolve uma lista paginada de métricas de atividade digital por usuário da organização autorizada.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v2.json get /v2/organizations/{organization_id}/digital-activity/user-metrics
openapi: 3.0.3
info:
  title: API Publica Portal
  version: 2.0.0
  description: API pública REST para portal
servers:
  - url: https://api.flexxible.net
    description: Portal API (production)
security:
  - bearerAuth: []
tags:
  - name: Atividade digital
    description: Criação de grupos de processos principais por organização
  - name: Roles
    description: Endpoint de creacion de roles de organizacion
  - name: Usuarios
    description: Endpoint de creacion de usuarios de organizacion
  - name: Grupos de workspaces
    description: Endpoints de gestión de grupos de workspaces
  - name: Workspaces
    description: Endpoint de eliminacion de workspaces de la organizacion
  - name: Aplicaciones instaladas
    description: Endpoint de detalle de aplicación instalada de la organización
  - name: Autenticación
    description: Endpoints de autenticación y contexto de sesión
  - name: Microservicios
    description: Detalle de microservicios por organizacion
  - name: Operaciones
    description: Consulta de detalle de operaciones por organización
  - name: Organización
    description: Operaciones de organización
  - name: Objetivos de política de parches
    description: Endpoints de gestión de objetivos de política de parches
  - name: Configuraciones de producto
    description: Endpoints de gestión de configuraciones de producto
  - name: Grupos de reporte
    description: Operaciones sobre grupos de reporte
  - name: Sesiones
    description: Endpoint de detalle de sesion de la organizacion
  - name: Tenants
    description: Endpoints de gestión de tenants
paths:
  /v2/organizations/{organization_id}/digital-activity/user-metrics:
    get:
      tags:
        - Atividade digital
      summary: Listar métricas de usuário
      description: >-
        Devolve uma lista paginada de métricas de atividade digital por usuário
        da organização autorizada.
      operationId: listDigitalActivityUserMetrics
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{24}$
            minLength: 24
            maxLength: 24
          description: Identificador da organização.
          example: 507f1f77bcf86cd799439011
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Número da página.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 100
          description: Número de elementos por página.
        - name: fields
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
          description: Campos de resposta separados por vírgulas para cada elemento.
          example: workspace_id,user_name,user_active_time_hours,month,year
        - name: filters
          in: query
          required: false
          schema:
            type: string
            maxLength: 5120
          description: Expressão JSON de filtros sobre campos filtráveis do recurso.
          examples:
            simple:
              summary: Filtrar por usuário
              value: '{"field":"user_name","op":"contains","value":"ana"}'
            complex-and:
              summary: Filtrar por ano e atividade máxima
              value: >-
                {"and":[{"field":"year","op":"eq","value":2025},{"field":"user_active_time_hours","op":"lte","value":120}]}
            complex-or-and:
              summary: Combinar organização e grupo de reporting
              value: >-
                {"and":[{"or":[{"field":"organization_id","op":"eq","value":"507f1f77bcf86cd799439011"},{"field":"organization_id","op":"eq","value":"507f1f77bcf86cd799439012"}]},{"field":"reporting_group_id","op":"eq","value":"64f0c2a1b2d3e4f506070822"}]}
        - name: sort
          in: query
          required: false
          schema:
            type: string
            pattern: ^([a-z_]+):(asc|desc)$
          description: >-
            Expressão de ordenação com o formato <field>:asc|desc sobre campos
            escalares ordenáveis da resposta.
          example: user_active_time_hours:desc
      responses:
        '200':
          description: Métricas de atividade digital por usuário recuperadas com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDigitalActivityUserMetricsResponseV2'
              examples:
                paginated_result:
                  summary: Lista paginada com resultados
                  value:
                    has_next: true
                    data:
                      - workspace_id: 64f0c2a1b2d3e4f506070811
                        user_name: ana.lopez
                        reporting_group_id: 64f0c2a1b2d3e4f506070822
                        reporting_time_hours: 120.5
                        opened_session_time_hours: 150.75
                        user_active_time_hours: 98.2
                        month: 3
                        year: 2025
                        deleted_date: null
                        organization_id: 507f1f77bcf86cd799439011
        '400':
          description: Parâmetros de solicitação inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_filters:
                  summary: Formato de filtros inválido
                  value:
                    error:
                      message: Formato de filtros no válido
                      code: bad_request
                      details: El parámetro filters debe ser una cadena JSON válida.
        '401':
          description: Não autorizado ou sem acesso à organização.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Falha de autorização
                  value:
                    error:
                      message: No autorizado
                      code: unauthorized
        '403':
          description: A atividade digital não está habilitada para a organização.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                digital_activity_not_enabled:
                  summary: Atividade digital não habilitada
                  value:
                    error:
                      message: Digital Activity is not enabled for organization
                      code: forbidden
        '404':
          description: Recurso não encontrado dentro da organização autorizada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Recurso inexistente
                  value:
                    error:
                      message: Recurso no encontrado
                      code: not_found
        '429':
          description: Limite de solicitações excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                too_many_requests:
                  summary: Solicitações em excesso
                  value:
                    error:
                      message: Demasiadas solicitudes
                      code: too_many_requests
        '500':
          description: Erro interno do servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unexpected_error:
                  summary: Erro inesperado
                  value:
                    error:
                      message: Error interno del servidor
                      code: internal_error
components:
  schemas:
    ListDigitalActivityUserMetricsResponseV2:
      type: object
      properties:
        has_next:
          type: boolean
          description: Indica se existe uma próxima página.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetDigitalActivityUserMetricsResponseV2'
      required:
        - has_next
        - data
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
    GetDigitalActivityUserMetricsResponseV2:
      type: object
      properties:
        workspace_id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do espaço de trabalho.
        user_name:
          type: string
          description: Identificador legível do usuário na métrica.
        reporting_group_id:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do grupo de relatórios associado.
        reporting_time_hours:
          type: number
          description: Horas de tempo reportado.
        opened_session_time_hours:
          type: number
          description: Horas de sessão aberta.
        user_active_time_hours:
          type: number
          description: Horas de atividade do usuário.
        month:
          type: integer
          minimum: 1
          maximum: 12
          description: Mês da métrica.
        year:
          type: integer
          minimum: 2000
          maximum: 2100
          description: Ano da métrica.
        deleted_date:
          type: string
          nullable: true
          pattern: ^\d{4}-\d{2}-\d{2}$
          description: Data de eliminação do workspace quando aplicável.
        organization_id:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador da organização associada à linha.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````