GET
/
consultas
/
consumo
Estatísticas de consumo
curl --request GET \
  --url https://api.sollosconsultas.com.br/consultas/consumo \
  --header 'x-access-token: <api-key>'
{
  "consumoHoje": {
    "quantidade": 12
  },
  "consumoSemanal": {
    "quantidade": 74
  },
  "consumoMensal": {
    "meses": [
      {
        "mes": "2025-05",
        "quantidade": 290
      },
      {
        "mes": "2025-06",
        "quantidade": 315
      },
      {
        "mes": "2026-03",
        "quantidade": 298
      },
      {
        "mes": "2026-04",
        "quantidade": 320
      }
    ]
  },
  "consumoBimestral": {
    "quantidade": 618
  },
  "consumoAnual": {
    "quantidade": 3840
  }
}

O que é contabilizado

Apenas execuções com status: success são contabilizadas. Execuções que falharam no provedor (failed) não entram no consumo. O consumo é calculado em tempo real a partir do histórico de execuções — não há um contador separado, então os valores sempre refletem o estado atual do banco.

Períodos disponíveis

CampoPeríodo
consumoHojeDia atual (meia-noite até agora)
consumoSemanalÚltimos 7 dias
consumoMensal.mesesBreakdown mensal dos últimos 12 meses
consumoBimestralÚltimos 61 dias
consumoAnualÚltimos 365 dias

Authorizations

x-access-token
string
header
required

Token JWT retornado pelo endpoint POST /auth/login. Inclua este header em todas as requisições autenticadas.

Response

Estatísticas de consumo consolidadas por período.

consumoHoje
object
consumoSemanal
object
consumoMensal
object
consumoBimestral
object
consumoAnual
object