Extrato - Resumo

Retorna o quantitativo dos relatórios consumidos agrupados por status.

Requisição Extrato Resumo

GET /api/usage/summary?year=2026&month=2&day=5

Parâmetros da requisição

Os parâmetros da requisição devem ser enviados via Query Params.

Campo	Descrição
year	Ano
month	Mês
day	Dia

INFO

Os parâmetros são opcionais. Caso não enviados a consulta será realizada no mês atual.

Exemplo de requisição

curl 
--location 
--request GET 'https://core.scorepositivo.com.br/api/usage/summary?year=2026&month=2&day=5' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI'

Parâmetros de resposta

Campo	Descrição
search.from	Data hora inicial da consulta. (em GTM -03:00).
search.to	Data hora final da consulta. (em GTM -03:00).
data	Lista com os dados agrupados por relatório e status.
report_id	Código do relatório.
status	Status
total	Quantidade de consultas no período.

Exemplo de resposta

{
    "search": {
        "from": "2026-02-05T00:00:00-03:00",
        "to": "2026-02-05T23:59:59-03:00"
    },
    "data": [
        {
            "report_id": "cpf-register-basic",
            "status": "SUCCESS",
            "total": 259
        },
        {
            "report_id": "cpf-finance-restriction",
            "status": "SUCCESS",
            "total": 64
        }
    ]
}