Skip to main content

​
📈 Consulta de Consumo

Esse endpoint retorna o consumo mensal por serviço utilizado na API Predictus, detalhando:
  • total de chamadas realizadas (totalChamadas)
  • total de registros retornados (totalRegistros)

​
Endpoint

GET https://api.predictus.inf.br/predictus-api/consumo/{ano-mes}
Exemplo: 
GET https://api.predictus.com.br/predictus-api/consumo/2025-05

​
Requisição

  • Autenticação obrigatória: Bearer Token
  • Parâmetro ano-mes no formato YYYY-MM

​
Headers

Authorization: Bearer {{token}}

​
Exemplo de requisição

curl --location 'https://api.predictus.com.br/predictus-api/consumo/2025-05' \
--header 'Authorization: Bearer {{token}}'

​
🧾 Resposta

A resposta será uma lista de objetos, cada um representando o consumo de um tipo de serviço:
CampoTipoDescrição
datastringMês da referência (YYYY-MM)
servicostringNome do serviço utilizado
totalChamadasintegerTotal de chamadas feitas ao serviço
totalRegistrosintegerTotal de registros retornados pelo serviço

​
Exemplo de resposta

[
    {
        "data": "2025-05",
        "servico": "DOSSIE_JURIDICO_POR_CPF_PARTE",
        "totalChamadas": 1447025,
        "totalRegistros": 11831480
    },
    {
        "data": "2025-05",
        "servico": "DOSSIE_JURIDICO_POR_CNPJ_PARTE",
        "totalChamadas": 6,
        "totalRegistros": 11918
    }
]