Skip to main content
GET
/
v1
/
transfers
/
dashboard
/
summary
Get dashboard summary
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/dashboard/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-Id: <x-tenant-id>'
{
  "contractVersion": "v1",
  "totalTransfers": 128,
  "byStatus": [
    {
      "status": "COMPLETED",
      "count": 101
    }
  ],
  "byType": [
    {
      "type": "TED_OUT",
      "count": 97
    }
  ],
  "health": {
    "status": "UP",
    "pendingCount": 0,
    "processingCount": 7,
    "terminalCount": 121,
    "failureCount": 20,
    "terminalFailRate": 0.1653
  },
  "generatedAt": "2026-02-01T12:00:00-03:00",
  "degraded": false,
  "degradationReasons": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. The token must include a tenantId claim that matches the X-Tenant-Id header.

Headers

​
X-Tenant-Id
string<uuid>
required

Organization ID used as the tenant identifier. All data is scoped to this organization. Must match the JWT tenantId claim when authentication is enabled.

Response

Dashboard summary returned successfully.

​
contractVersion
string

Version of the dashboard response contract.

Example:

"v1"

​
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.

​
health
object

Operational health snapshot.

​
generatedAt
string<date-time>

Timestamp when the summary was generated.

Example:

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

​
degraded
boolean

Whether the system is in a degraded state.

Example:

false

​
degradationReasons
string[]

List of degradation reasons when degraded is true.