Pular para o conteúdo principal
GET
/
v1
/
transfers
/
dashboard
/
summary
Obter resumo do dashboard
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>"
  ]
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O token deve incluir uma claim tenantId que corresponda ao cabeçalho X-Tenant-Id.

Cabeçalhos

​
X-Tenant-Id
string<uuid>
obrigatório

ID da organização usado como identificador do tenant. Todos os dados são limitados a esta organização. Deve corresponder à claim tenantId do JWT quando a autenticação está habilitada.

Resposta

Resumo do dashboard retornado com sucesso.

​
contractVersion
string

Versão do contrato de resposta do dashboard.

Exemplo:

"v1"

​
totalTransfers
integer

Total de transferências no período.

Exemplo:

128

​
byStatus
object[]

Contagem de transferências agrupada por status.

​
byType
object[]

Contagem de transferências agrupada por tipo.

​
health
object

Instantâneo de saúde operacional.

​
generatedAt
string<date-time>

Timestamp de quando o resumo foi gerado.

Exemplo:

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

​
degraded
boolean

Se o sistema está em estado degradado.

Exemplo:

false

​
degradationReasons
string[]

Lista de motivos de degradação quando degraded é true.