Get dashboard summary
Returns aggregated transfer counters and operational health snapshot for dashboards. The window parameter sets the period that the counters cover. byReconciliationStatus, health.processingCount, and health.pendingCount count the current state and ignore the window.
Authorizations
JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.
Headers
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.
Query Parameters
The period that the counters cover.
24h, 7d, 30d, all When true, asks for fresh numbers instead of the cached snapshot. The service can still answer with the cached snapshot when another refresh of the same window ran recently.
Response
Dashboard summary returned successfully.
Version of the dashboard response contract.
"v1"
The period that the counters cover.
24h, 7d, 30d, all "24h"
The instant that the window opened. null for all.
"2026-02-01T12:00:00Z"
Total number of transfers in the period.
128
Transfer count grouped by status.
Transfer count grouped by type.
The current reconciliation backlog, grouped by status. The window does not apply. An empty array means that the backlog is empty. null means that the backlog could not be read, and degraded is then true.
Operational health snapshot.
Timestamp when the summary was generated.
"2026-02-01T15:00:00Z"
Whether the system is in a degraded state.
false
List of degradation reasons when degraded is true.

