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

# getRA1

> <h2>Retorna o relatório de aproveitamento por operação (RA1).</h2>

<h6 class="label label-success">Response:</h6>

Para cada status (ex.: Solicitou retorno, Caixa Postal, etc), será retornada a estrutura que segue:

<table class="table table-hover"> <tbody><tr><td>qtd</td><td>Quantidade</td></tr> <tr><td>tempo</td><td>tempo em ligação</td></tr> <tr><td>percentual</td><td>Percentual em relação ao total</td></tr> <tr><td>tempo_medio</td><td>Média de tempo em todas as ligações deste status</td></tr> </tbody></table>

Também retornará a estrutura que segue para o result da operação e o result total.

<table class="table table-hover"> <tbody><tr><td>qtd_total</td><td>Quantidade total de ligações</td></tr> <tr><td>tempo_total</td><td>tempo total em ligação</td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getRA1
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/getRA1:
    post:
      tags:
        - Relatórios
      summary: getRA1
      description: >-
        <h2>Retorna o relatório de aproveitamento por operação (RA1).</h2>


        <h6 class="label label-success">Response:</h6>


        Para cada status (ex.: Solicitou retorno, Caixa Postal, etc), será
        retornada a estrutura que segue:


        <table class="table table-hover">
        <tbody><tr><td>qtd</td><td>Quantidade</td></tr>
        <tr><td>tempo</td><td>tempo em ligação</td></tr>
        <tr><td>percentual</td><td>Percentual em relação ao total</td></tr>
        <tr><td>tempo_medio</td><td>Média de tempo em todas as ligações deste
        status</td></tr> </tbody></table>


        Também retornará a estrutura que segue para o result da operação e o
        result total.


        <table class="table table-hover">
        <tbody><tr><td>qtd_total</td><td>Quantidade total de ligações</td></tr>
        <tr><td>tempo_total</td><td>tempo total em ligação</td></tr>
        </tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                de:
                  type: string
                  description: >-
                    AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH =
                    hora, MM = minuto, SS = segundo, exemplo: 2020513080000).
                  example: de
                ate:
                  type: string
                  description: >-
                    AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH =
                    hora, MM = minuto, SS = segundo, exemplo: 2020513080000).
                  example: ate
                operacao:
                  type: string
                  description: Nome da operação.
                  example: operacao
                fila:
                  type: string
                  description: >-
                    [Opcional] Nome da fila. Se não for informado retorna os
                    dados de todas as filas.
                  example: fila
                lote:
                  type: string
                  description: >-
                    [Opcional] Nome do lote. Se não for informado retorna os
                    dados de todos os lotes.
                  example: lote
                time:
                  type: string
                  description: >-
                    [Opcional] Nome do time. Se não for informado retorna os
                    dados de todos os times.
                  example: time
                user:
                  type: string
                  description: >
                    [Opcional] Login/username do agente. Se não for informado
                    retorna os dados de todos os agentes.
                  example: usuario
              required:
                - de
                - ate
                - operacao
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````