# Busca valores agregados

Busca valores agregados baseados nos parâmetros fornecidos.

Endpoint: GET /api/v3/statistics/aggregate
Version: 3.0.0
Security: OAuth2

## Query parameters:

  - `data_source` (string, required)
    Fonte de dados a ser utilizada.

- sale: Vendas
- transaction: Transações
    Enum: "sale", "transaction"

  - `metric` (string, required)
    Métrica a ser utilizada.

- total_amount: Valor total das vendas
- ticket_avg: Valor médio das vendas
    Enum: "total_amount", "ticket_avg"

  - `begin_date` (string, required)
    Data inicial do período de busca.

Formato: YYYY-MM-DD
    Example: "2025-01-01"

  - `until_date` (string, required)
    Data final do período de busca.

Formato: YYYY-MM-DD
    Example: "2025-01-31"

  - `filters` (object)
    Filtros a serem aplicados de acordo com o módulo referente ao data_source.

Atualmente implementado apenas para:
- transaction: Utiliza o mesmo filtro da rota /api/v3/financial/transactions
    Example: {"type":"income","description":"Receita"}

  - `with_additional_data` (boolean)
    Incluir dados do período anterior.

Para estatísticas agregadas, o período anterior será a mesma quantidade de dias do filtro selecionado imediatamente antes do filtro inicial.

Exemplo: se o filtro inicial for 2025-01-08 e o filtro final for 2025-01-14, o período anterior será 2024-01-01 e 2024-01-07.

## Response 200 fields (application/json):

  - `data` (object)
    Dados estatísticos agregados

  - `data.value` (number, required)
    Valor da métrica para o período selecionado.
    Example: 1000

  - `data.count` (integer, required)
    Quantidade de registros envolvidos no cálculo da métrica.
    Example: 100

  - `data.additional_data` (object)
    Dados adicionais da métrica de acordo com o data_source e metric.

Valores possíveis:
- previous_value: Valor da métrica para o período anterior.
- count_pending_transactions: Quantidade de transações pendentes no filtro especificado.

  - `data.additional_data.previous_value` (number)
    Valor da métrica para o período anterior.
    Example: 900

  - `data.additional_data.count_pending_transactions` (integer)
    Quantidade de transações pendentes no filtro especificado.
    Example: 10

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields