Extrato - Detalhado

Retorna todas as consultas realizadas em um determinado relatório.

Requisição Extrato Detalhado

O código do relatório a ser consultado deve ser enviado via URL.

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

Parâmetros da requisição

Os parâmetros devem ser enviados via Query Params.

Campo	Descrição
year	Ano
month	Mês
day	Dia
page	O número da página que deseja recuperar. Padrão: 1. A consulta é por paginação, 500 itens por página.

INFO

Os parâmetros year, month e day 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/statement/cpf-register-basic?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).
search.report_id	Relatório consultado.
statement	Objeto com o resultado.
statement.total	Total de itens/consultas encontrados.
statement.per_page	A quantidade de itens exibidos por página. Padrão: 500.
statement.current_page	Página atual.
statement.last_page	Ultima Página.
statement.data	Lista com as consultas realizadas.
id	ID da consulta.
created_at	Data da consulta.
document	Documento.
status	Status
external_id	ID externo.
ip	Endereço IP da requisição.

Exemplo de resposta

{
    "search": {
        "from": "2026-02-05T00:00:00-03:00",
        "to": "2026-02-05T23:59:59-03:00",
        "report_id": "cpf-register-basic"
    },
    "statement": {
        "total": 261,
        "per_page": 500,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": "f96cf41b-faf7-46cf-88c1-e5ed4438e7f2",
                "created_at": "2026-02-06T00:27:13-03:00",
                "document": "12399117778",
                "status": "SUCCESS",
                "external_id": null,
                "ip": "200.150.198.67"
            },
            {
                "id": "b99337cd-7d15-4880-a293-1e30739cc098",
                "created_at": "2026-02-06T00:00:43-03:00",
                "document": "09698459448",
                "status": "SUCCESS",
                "external_id": null,
                "ip": "200.150.198.72"
            }
        ]
    }
}