Skip to main content
GET
Get dashboard summary

Authorizations

Authorization
string
header
required

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

X-Organization-Id
string<uuid>
required

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

window
enum<string>
default:24h

The period that the counters cover.

Available options:
24h,
7d,
30d,
all
refresh
boolean
default:false

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.

contractVersion
string

Version of the dashboard response contract.

Example:

"v1"

window
enum<string>

The period that the counters cover.

Available options:
24h,
7d,
30d,
all
Example:

"24h"

windowStart
string<date-time> | null

The instant that the window opened. null for all.

Example:

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

totalTransfers
integer

Total number of transfers in the period.

Example:

128

byStatus
object[]

Transfer count grouped by status.

byType
object[]

Transfer count grouped by type.

byReconciliationStatus
object[] | null

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.

health
object

Operational health snapshot.

generatedAt
string<date-time>

Timestamp when the summary was generated.

Example:

"2026-02-01T15:00:00Z"

degraded
boolean

Whether the system is in a degraded state.

Example:

false

degradationReasons
string[]

List of degradation reasons when degraded is true.