> For the complete documentation index, see [llms.txt](https://docs.scorepositivo.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scorepositivo.com.br/relatorios/extrato/extrato-resumo.md).

# Extrato - Resumo

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

## Requisição Extrato Resumo

{% hint style="info" %} <mark style="color:orange;">**GET**</mark>        /api/usage/summary?year=2026\&month=2\&day=5
{% endhint %}

#### Parâmetros da requisição

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

<table><thead><tr><th width="262">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>year</strong></td><td>Ano</td></tr><tr><td><strong>month</strong></td><td>Mês </td></tr><tr><td><strong>day</strong></td><td>Dia</td></tr></tbody></table>

{% hint style="warning" %} <mark style="color:orange;">**INFO**</mark>

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

#### Exemplo de requisição

```json
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

<table><thead><tr><th width="258">Campo</th><th>Descrição</th></tr></thead><tbody><tr><td>search.from</td><td>Data hora inicial da consulta. (em GTM -03:00).</td></tr><tr><td>search.to</td><td>Data hora final da consulta. (em GTM -03:00).</td></tr><tr><td>data</td><td>Lista com os dados agrupados por relatório e status.</td></tr><tr><td>report_id</td><td>Código do relatório.</td></tr><tr><td>status</td><td>Status</td></tr><tr><td>total</td><td>Quantidade de consultas no período.</td></tr></tbody></table>

#### Exemplo de resposta

```json
{
    "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
        }
    ]
}
```