> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get dashboard summary > Returns aggregated transfer counters and operational health snapshot for dashboards. ## OpenAPI ````yaml /en/openapi/v3-current/ted.yaml get /v1/transfers/dashboard/summary openapi: 3.0.3 info: title: Bank Transfer (TED) Plugin API description: >- Complete API for Brazilian bank transfers (TED OUT, TED IN, P2P) through the Lerian platform, including transfer initiation, processing, status tracking, and cancellation. version: 2.5.0-beta.5 servers: - url: https://plugin-br-bank-transfer.sandbox.lerian.net description: Sandbox (placeholder — not yet available for public access) security: - BearerAuth: [] tags: - name: Transfers API description: Endpoints for initiating, processing, tracking, and cancelling transfers. - name: Webhook DLQ description: Endpoints for inspecting and retrying webhook dead-letter queue messages. - name: Health API description: Endpoints for checking service liveness and readiness. paths: /v1/transfers/dashboard/summary: get: tags: - Transfers API summary: Get dashboard summary description: >- Returns aggregated transfer counters and operational health snapshot for dashboards. operationId: getDashboardSummary parameters: - $ref: '#/components/parameters/XOrganizationId' responses: '200': description: Dashboard summary returned successfully. content: application/json: schema: type: object properties: contractVersion: type: string description: Version of the dashboard response contract. example: v1 totalTransfers: type: integer description: Total number of transfers in the period. example: 128 byStatus: type: array description: Transfer count grouped by status. items: type: object properties: status: type: string example: COMPLETED count: type: integer example: 101 byType: type: array description: Transfer count grouped by type. items: type: object properties: type: type: string example: TED_OUT count: type: integer example: 97 health: type: object description: Operational health snapshot. properties: status: type: string description: Overall health status. example: UP pendingCount: type: integer example: 0 processingCount: type: integer example: 7 terminalCount: type: integer example: 121 failureCount: type: integer example: 20 terminalFailRate: type: number format: float example: 0.1653 generatedAt: type: string format: date-time description: Timestamp when the summary was generated. example: '2026-02-01T12:00:00-03:00' degraded: type: boolean description: Whether the system is in a degraded state. example: false degradationReasons: type: array description: List of degradation reasons when degraded is true. items: type: string '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimitExceeded' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: XOrganizationId: name: X-Organization-Id in: header required: true description: >- Organization ID used as the tenant identifier. All data is scoped to this organization. Must match the JWT tenantId claim when authentication is enabled. schema: type: string format: uuid example: 019c96a0-0a98-7287-9a31-786e0809c769 responses: BadRequest: description: >- Indicates that the request contains invalid input. Check the field details for specific validation errors. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidInput: summary: Validation error value: error: code: BTF-0001 title: Invalid Input message: >- The request contains invalid fields. Check the field details below. fields: recipientIspb: must be 8 digits amount: must be positive Unauthorized: description: Indicates that the request is missing a valid authentication token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Missing authorization value: error: code: BTF-0401 title: Unauthorized message: Missing or invalid authentication token RateLimitExceeded: description: >- Indicates that the rate limit has been exceeded. Retry after the number of seconds specified in the Retry-After header. headers: Retry-After: description: Seconds until rate limit resets schema: type: integer example: 60 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimitExceeded: summary: Too many requests value: error: code: BTF-0001 title: Invalid input message: >- Too many requests. Retry after the interval indicated by the `Retry-After` header. description: > Rate-limit responses share the `BTF-0001` code with other 4xx validation errors. Clients should detect rate limiting via HTTP status `429` and the `Retry-After` header rather than the error code. ServiceUnavailable: description: >- Indicates that an external service (CRM, JD SPB, Midaz, or Fees) is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: crmUnavailable: summary: CRM service down value: error: code: BTF-0502 title: CRM Service Unavailable message: >- Unable to validate account. The CRM service is temporarily unavailable. Try again later. jdUnavailable: summary: JD SPB unavailable value: error: code: TRANSPORT title: JD SPB Unavailable message: >- Unable to submit transfer. The JD SPB service is temporarily unavailable. Try again later. midazUnavailable: summary: Midaz ledger unavailable value: error: code: BTF-2000 title: Midaz Unavailable message: >- Unable to process transfer. The Midaz ledger service is temporarily unavailable. Try again later. feeServiceUnavailable: summary: Fee service unavailable (fail-closed mode) value: error: code: BTF-3000 title: Fee Service Unavailable message: >- Unable to calculate fee. The fee service is temporarily unavailable. Try again later. dlqInspectorUnavailable: summary: DLQ inspector not configured value: error: code: BTF-9005 title: DLQ Inspector Unavailable message: DLQ inspector is not configured schemas: ErrorResponse: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string pattern: ^BTF-[0-9]{4}$ description: The error code in BTF-XXXX format. example: BTF-0010 title: type: string description: A short, human-readable title for the error. example: Operating Hours Violation message: type: string description: A detailed description of the error. example: >- Transfers can only be initiated Monday-Friday between 06:30 and 17:00 Brasília time fields: type: object additionalProperties: true description: Field-level validation errors for request body parameters. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 headers: type: object additionalProperties: true description: Validation errors for request headers. paths: type: object additionalProperties: true description: Validation errors for path parameters. queryParams: type: object additionalProperties: true description: Validation errors for query parameters. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT Bearer token authentication. The token must include a tenantId claim that matches the X-Organization-Id header. ````