> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerando relatórios

> Gere resumos de reconciliação, detalhes de correspondência, visões de exceções e trilhas de auditoria para acompanhar resultados e atender exigências de compliance.

Os relatórios transformam uma execução de reconciliação em algo sobre o qual você pode agir e que pode entregar aos auditores: quanto foi correspondido, o que ainda está em aberto, quanto dinheiro está exposto e quem fez o quê. As equipes de operações os usam para trabalhar a fila do dia; finanças e compliance os usam para fechar os livros e comprovar controle.

## Relatórios disponíveis

***

Cada relatório responde a uma pergunta diferente:

* **Resumo da reconciliação**: Uma visão geral de alto nível das taxas de correspondência, volume de exceções e variações totais.
* **Relatório de detalhes de correspondência**: Uma lista completa das correspondências, incluindo detalhes das transações, pontuações de confiança e detalhamento de variações.
* **Relatório de exceções**: Uma visão focada das exceções não resolvidas com envelhecimento, severidade e status de resolução.
* **Relatório de trilha de auditoria**: Um registro cronológico da atividade de reconciliação para investigação e conformidade.

Use os endpoints do dashboard de relatórios para acessar métricas de reconciliação e exportar dados.

<Tip>Referência da API: [Agregados do dashboard](/pt/reference/matcher/get-dashboard-aggregates) | [Exportar relatório de correspondidos](/pt/reference/matcher/export-matched-report) | [Exportar relatório de não correspondidos](/pt/reference/matcher/export-unmatched-report)</Tip>

## Análises do dashboard

***

O dashboard de relatórios fornece métricas de reconciliação em tempo real para qualquer contexto e intervalo de datas.

### Agregados do dashboard

Use o endpoint combinado de agregados do dashboard para uma única chamada que retorna estatísticas de volume, taxa de correspondência e SLA para um contexto:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

`GET /v1/reports/contexts/{contextId}/dashboard` aceita `date_from`, `date_to` e um filtro opcional `source_id`, e retorna um `DashboardAggregatesResponse`:

| Campo       | Descrição                                                          |
| ----------- | ------------------------------------------------------------------ |
| `volume`    | Estatísticas de volume de transações para o intervalo              |
| `matchRate` | Estatísticas de taxa de correspondência (correspondidos vs. total) |
| `sla`       | Estatísticas de SLA para o tratamento de exceções                  |
| `updatedAt` | Quando os agregados foram calculados pela última vez (RFC 3339)    |

Fatias mais granulares do dashboard estão disponíveis em `/v1/reports/contexts/{contextId}/dashboard/*` (por exemplo `metrics`, `match-rate`, `sla`, `volume`, `source-breakdown` e `cash-impact`).

<Note>
  Não existe um endpoint `GET /v1/reports/contexts/{contextId}` simples. Os dados de relatórios são servidos por meio dos sub-caminhos tipados em `/v1/reports/contexts/{contextId}/...` — por exemplo `dashboard`, `summary`, `matched`, `unmatched` e `variance` (cada um com uma variante `/export`).
</Note>

<Tip>Referência da API: [Obter agregados do dashboard](/pt/reference/matcher/get-dashboard-aggregates)</Tip>

### Detalhamento por fonte

Visualize o desempenho da reconciliação por fonte — incluindo taxas de correspondência, contagens de transações e valores não correspondidos:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard/source-breakdown?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

<Tip>Referência da API: [Obter detalhamento por fonte](/pt/reference/matcher/get-source-breakdown)</Tip>

### Impacto financeiro

Avalie a exposição financeira total das transações não correspondidas, detalhada por moeda e idade:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard/cash-impact?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

A resposta inclui detalhamentos `byCurrency` e `byAge` para ajudar a priorizar os esforços de resolução.

<Tip>Referência da API: [Obter impacto financeiro](/pt/reference/matcher/get-cash-impact)</Tip>

## Paginação

***

Os endpoints de relatórios de correspondidos, não correspondidos e variância usam paginação baseada em cursor. Passe o valor `cursor` de uma resposta anterior para recuperar a próxima página de resultados.

Se um valor de cursor inválido for fornecido, a API retorna um erro `400 Bad Request` com uma mensagem indicando que os parâmetros de paginação são inválidos. Versões anteriores retornavam um erro `500` nesse caso.

## Contagens rápidas

***

Use os endpoints de contagem para verificações de status leves sem buscar conjuntos de resultados completos:

| Endpoint                                                           | Descrição                                                  |
| ------------------------------------------------------------------ | ---------------------------------------------------------- |
| [Contar correspondências](/pt/reference/matcher/count-matches)     | Total de itens correspondidos em um intervalo de datas     |
| [Contar transações](/pt/reference/matcher/count-transactions)      | Total de transações em um intervalo de datas               |
| [Contar exceções](/pt/reference/matcher/count-exceptions)          | Total de exceções em um intervalo de datas                 |
| [Contar não correspondidos](/pt/reference/matcher/count-unmatched) | Total de itens não correspondidos em um intervalo de datas |

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/matches/count?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

Cada endpoint de contagem retorna um único valor `count` — ideal para dashboards leves ou verificações de saúde que não precisam do conjunto de resultados completo.

## Melhores práticas

***

<AccordionGroup>
  <Accordion title="Agende resumos diários">
    Automatize um relatório de resumo diário entregue todas as manhãs para manter as partes interessadas alinhadas.
  </Accordion>

  <Accordion title="Arquive exportações para conformidade">
    Armazene relatórios em armazenamento seguro e durável. Artefatos financeiros frequentemente requerem retenção de vários anos.
  </Accordion>

  <Accordion title="Use filtros para manter a relevância">
    Gere relatórios direcionados por data, status, severidade ou fonte—evite exportar tudo por padrão.
  </Accordion>

  <Accordion title="Torne as exportações autoexplicativas">
    Inclua nomes de fontes, nomes de regras e identificadores-chave para que a saída possa ser autônoma fora do Matcher.
  </Accordion>

  <Accordion title="Monitore jobs de relatório">
    Relatórios grandes podem falhar ou travar. Acompanhe o status do job e alerte em `FAILED` ou `GENERATING` prolongado.
  </Accordion>
</AccordionGroup>

## Próximos passos

***

<Card title="Contextos e Fontes" icon="database" href="/pt/matcher/configuration/matcher-contexts-and-sources" horizontal>
  Configure contextos de reconciliação e fontes de dados.
</Card>

<Card title="Segurança" icon="shield-halved" href="/pt/matcher/reference/matcher-security" horizontal>
  Aprenda como o controle de acesso e a proteção de dados funcionam no Matcher.
</Card>
