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

# Obter relatório mensal de um grupo de relatório

> Retorna o relatório mensal de suporte para o grupo de relatório e período solicitado, junto com as métricas atuais do grupo.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v2.json get /v2/organizations/{organization_id}/reporting-groups/{reporting_group_id}/monthly-report/{period}
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}/reporting-groups/{reporting_group_id}/monthly-report/{period}:
    get:
      tags:
        - Grupos de relatório
      summary: Obter relatório mensal de um grupo de relatório
      description: >-
        Retorna o relatório mensal de suporte para o grupo de relatório e
        período solicitado, junto com as métricas atuais do grupo.
      operationId: get_reportinggroup_monthly_report
      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: reporting_group_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{24}$
            minLength: 24
            maxLength: 24
          description: Identificador do grupo de relatório.
          example: 507f1f77bcf86cd799439020
        - name: period
          in: path
          required: true
          schema:
            type: string
            pattern: ^\d{4}(0[1-9]|1[0-2])$
            minLength: 6
            maxLength: 6
          description: Período mensal solicitado no formato yyyymm.
          example: '202606'
      responses:
        '200':
          description: Relatório mensal obtido corretamente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportingGroupMonthlyReportResponseV2'
              examples:
                ok:
                  summary: Resposta correta
                  value:
                    reporting_group_id: 507f1f77bcf86cd799439020
                    organization_id: 507f1f77bcf86cd799439011
                    period_year: 2026
                    period_month: 6
                    applied_patches: 58
                    critical_patches: 6
                    security_patches: 17
                    other_patches: 35
                    total_used_apps: 42
                    top_apps:
                      - app_name: Google Chrome
                        usage_days: 21
                      - app_name: Microsoft Teams
                        usage_days: 19
                    automatic_remediations:
                      microservices: 4
                      flows: 11
                    current_reporting_group_name: Madrid - Finance
                    current_total_workspaces: 132
                    current_total_workspace_users: 247
                    current_workspace_antivirus_statistics:
                      workspaces_without_antivirus: 9
                      workspaces_with_antivirus:
                        total: 123
                        by_status:
                          unknown: 5
                          not_installed: 7
                          installed_stopped: 3
                          installed_working: 108
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                period_invalid:
                  summary: Período inválido
                  value:
                    error:
                      message: El parametro period debe tener formato yyyymm.
                      code: invalid_request
                      details: Use seis digitos con mes valido entre 01 y 12.
        '401':
          description: Não autorizado para esta organização.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Não autorizado
                  value:
                    error:
                      message: No autorizado.
                      code: unauthorized
        '404':
          description: >-
            Relatório mensal não encontrado para o grupo de relatório e período
            indicados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Não encontrado
                  value:
                    error:
                      message: No se encontro el reporte mensual solicitado.
                      code: not_found
        '500':
          description: Erro interno do servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Erro interno
                  value:
                    error:
                      message: Se produjo un error interno.
                      code: internal_error
components:
  schemas:
    GetReportingGroupMonthlyReportResponseV2:
      type: object
      description: Relatório mensal de suporte de um grupo de relatório.
      properties:
        reporting_group_id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do grupo de relatório.
        organization_id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador da organização.
        period_year:
          type: integer
          minimum: 1
          description: Ano do relatório.
        period_month:
          type: integer
          minimum: 1
          maximum: 12
          description: Mês do relatório.
        applied_patches:
          type: integer
          description: Número de patches aplicados.
        critical_patches:
          type: integer
          description: Número de patches críticos.
        security_patches:
          type: integer
          description: Número de patches de segurança.
        other_patches:
          type: integer
          description: Número de outros patches.
        total_used_apps:
          type: integer
          description: Quantidade total de aplicativos usados no período.
        top_apps:
          type: array
          description: Aplicativos mais usados no período.
          items:
            $ref: '#/components/schemas/ReportingGroupMonthlyTopAppV2'
        automatic_remediations:
          $ref: '#/components/schemas/ReportingGroupMonthlyAutomaticRemediationsV2'
        current_reporting_group_name:
          type: string
          description: Nome atual do grupo de relatório.
        current_total_workspaces:
          type: integer
          description: Total atual de workspaces do grupo.
        current_total_workspace_users:
          type: integer
          description: Total atual de usuários em workspaces do grupo.
        current_workspace_antivirus_statistics:
          $ref: >-
            #/components/schemas/ReportingGroupMonthlyCurrentWorkspaceAntivirusStatisticsV2
      required:
        - reporting_group_id
        - organization_id
        - period_year
        - period_month
        - applied_patches
        - critical_patches
        - security_patches
        - other_patches
        - total_used_apps
        - top_apps
        - automatic_remediations
        - current_reporting_group_name
        - current_total_workspaces
        - current_total_workspace_users
        - current_workspace_antivirus_statistics
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
    ReportingGroupMonthlyTopAppV2:
      type: object
      description: Aplicativo e número de dias de uso durante o período.
      properties:
        app_name:
          type: string
          description: Nome do aplicativo.
        usage_days:
          type: integer
          description: Dias de uso do aplicativo.
      required:
        - app_name
        - usage_days
    ReportingGroupMonthlyAutomaticRemediationsV2:
      type: object
      description: Contagem de remediações automáticas.
      properties:
        microservices:
          type: integer
          description: Quantidade de remediações por microsserviços.
        flows:
          type: integer
          description: Quantidade de remediações por fluxos.
      required:
        - microservices
        - flows
    ReportingGroupMonthlyCurrentWorkspaceAntivirusStatisticsV2:
      type: object
      description: Estado atual do antivírus em workspaces do grupo.
      properties:
        workspaces_without_antivirus:
          type: integer
          description: Quantidade de workspaces sem antivírus.
        workspaces_with_antivirus:
          $ref: '#/components/schemas/ReportingGroupMonthlyWorkspacesWithAntivirusV2'
      required:
        - workspaces_without_antivirus
        - workspaces_with_antivirus
    ReportingGroupMonthlyWorkspacesWithAntivirusV2:
      type: object
      description: Resumo de workspaces com antivírus.
      properties:
        total:
          type: integer
          description: Total de workspaces com antivírus.
        by_status:
          $ref: >-
            #/components/schemas/ReportingGroupMonthlyWorkspacesWithAntivirusByStatusV2
      required:
        - total
        - by_status
    ReportingGroupMonthlyWorkspacesWithAntivirusByStatusV2:
      type: object
      description: Distribuição por estado do antivírus.
      properties:
        unknown:
          type: integer
          description: Workspaces com estado desconhecido.
        not_installed:
          type: integer
          description: Workspaces com antivírus não instalado.
        installed_stopped:
          type: integer
          description: Workspaces com antivírus instalado e parado.
        installed_working:
          type: integer
          description: Workspaces com antivírus instalado e operacional.
      required:
        - unknown
        - not_installed
        - installed_stopped
        - installed_working
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````