# Busca dados estatísticos

Busca dados estatísticos baseados nos parâmetros fornecidos.

Endpoint: GET /api/v3/statistics/series
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"

  - `group_type` (string)
    Tipo de agrupamento dos dados.

- year: Agrupamento por ano
- month: Agrupamento por mês
- day: Agrupamento por dia
    Enum: "year", "month", "day"

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

Para estatísticas por série, o período anterior será sempre o mesmo do período atual, porém com dados do ano anterior.

## Response 200 fields (application/json):

  - `data` (object)
    Dados estatísticos por série

  - `data.items` (array, required)

  - `data.items.group` (string, required)
    Valor do agrupamento.

Exemplo: 2025-01-01 para o agrupamento por dia, 2025-01 para o agrupamento por mês, 2025 para o agrupamento por ano.
    Example: "2025-01-01"

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

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

  - `data.previous_period` (array)

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