Estatísticas de Uso

get

https://api-gateway-v2.registrorural.com.br/usage/stats

Retorna estatísticas de uso agregadas por dia, semana ou mês, de acordo com a solicitação do usuário. As métricas disponíveis são valor gasto ou quantidade de requests do usuário.

Métricas disponíveis:

spent: Valor total gasto pelo usuário (em BRL - Reais)
requests: Quantidade de requests realizados pelo usuário
all: Ambas as métricas (spent e requests) em uma única resposta

Períodos de agregação:

day: Agregação diária
week: Agregação semanal
month: Agregação mensal

Valores padrão:

metric_type: requests
aggregation_period: day
lookback_periods: 15

Limitações:

Máximo de 1000 períodos para lookback
Breakdown disponível apenas para métrica requests
Use lookback_periods OU start_date/end_date, não ambos

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

metric_type

string

enum

[opcional] Tipo de métrica a ser consultada. spent para valor gasto (em BRL - Reais), requests para quantidade de requests, ou all para ambas as métricas. Default: requests.

Allowed:

aggregation_period

string

enum

[opcional] Período de agregação dos dados. day para agregação diária, week para semanal ou month para mensal. Default: day.

Allowed:

lookback_periods

string

[opcional] Quantidade de períodos para "look back" (ex: 15 dias atrás, 3 meses atrás). Máximo 1000 períodos. Default: 15. Nota: Use este parâmetro OU start_date/end_date, não ambos.

start_date

date

[opcional] Data de início no formato YYYY-MM-DD. Nota: Use este parâmetro junto com end_date OU use lookback_periods, não ambos.

end_date

date

[opcional] Data de fim no formato YYYY-MM-DD. Nota: Use este parâmetro junto com start_date OU use lookback_periods, não ambos.

breakdown

string

enum

[opcional] Se true, retorna breakdown por produto (apenas para métrica requests). Default: false.

Allowed:

Responses

200Sucesso

400Erro de validação