Skip to main content
GET
Get dashboard summary

Autorizações

Authorization
string
header
obrigatório

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Cabeçalhos

X-Organization-Id
string<uuid>
obrigatório

Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's ORGANIZATION_ID env.

Resposta

Dashboard summary returned successfully.

contractVersion
string

Version of the dashboard response contract.

Exemplo:

"v1"

totalTransfers
integer

Total number of transfers in the period.

Exemplo:

128

byStatus
object[]

Transfer count grouped by status.

byType
object[]

Transfer count grouped by type.

health
object

Operational health snapshot.

generatedAt
string<date-time>

Timestamp when the summary was generated.

Exemplo:

"2026-02-01T12:00:00-03:00"

degraded
boolean

Whether the system is in a degraded state.

Exemplo:

false

degradationReasons
string[]

List of degradation reasons when degraded is true.