Sign in

v1

latestOpenAPI 3.0.32026-07-2416056.4 KB
Estatísticas de Uso

Estatísticas de Uso

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
get/usage/stats

Query parameters

metric_type'spent' | 'requests' | 'all'
Example:requests

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

aggregation_period'day' | 'week' | 'month'
Example:day

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

lookback_periodsstring
Example:15

[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_datestring date
Example:2024-01-01

[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_datestring date
Example:2024-01-31

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

breakdownstring
Example:false

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

Response

Sucesso

Example response

{
  "data": {
    "metric_type": "requests",
    "aggregation_period": "day",
    "lookback_periods": 15,
    "start_date": "2024-01-01",
    "end_date": "2024-01-31",
    "stats": [
      {
        "period": "2024-01-01",
        "value": 25
      }
    ],
    "spent_stats": [
      {
        "period": "2024-01-01",
        "value": 150.5
      }
    ],
    "requests_stats": [
      {
        "period": "2024-01-01",
        "value": 25,
        "breakdown": null
      },
      {
        "period": "2024-01-02",
        "value": 18,
        "breakdown": null
      }
    ]
  }
}