> ## 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. # Dashboard summary > Returns aggregate metrics for the tenant: total received, unread, avg time to read, unread >3/7/15 days, and breakdown by sender. All counts are scoped to the given period (defaults to the last 30 days). ## OpenAPI ````yaml /pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/dashboard/summary openapi: 3.1.0 info: description: >- API for Lerian BC Correios, which connects the institution to BC Correio, Banco Central do Brasil's electronic correspondence system. It retrieves and stores the institution's BC Correio mail, sends messages to BACEN departments, and keeps an audit trail. title: Lerian BC Correios API version: 1.0.0 servers: - url: https://bc-correios.sandbox.lerian.net security: - BearerAuth: [] tags: - description: Mail listing, search, read, send, and lifecycle operations. name: Mails - description: Immutable audit-trail query and export. name: Audit - description: 'Per-tenant configuration: BCB credentials, polling, AI, retention.' name: Settings - description: Aggregate mail metrics and category breakdowns. name: Dashboard paths: /api/v1/correios/dashboard/summary: get: tags: - Dashboard summary: Dashboard summary description: >- Returns aggregate metrics for the tenant: total received, unread, avg time to read, unread >3/7/15 days, and breakdown by sender. All counts are scoped to the given period (defaults to the last 30 days). operationId: GetDashboardSummary parameters: - description: >- Period start (ISO 8601 / RFC 3339, e.g. 2026-01-01T00:00:00Z). Defaults to 30 days ago. explode: false in: query name: startDate schema: description: >- Period start (ISO 8601 / RFC 3339, e.g. 2026-01-01T00:00:00Z). Defaults to 30 days ago. examples: - '2026-01-01T00:00:00Z' type: string - description: >- Period end (ISO 8601 / RFC 3339, e.g. 2026-03-31T23:59:59Z). Defaults to now. explode: false in: query name: endDate schema: description: >- Period end (ISO 8601 / RFC 3339, e.g. 2026-03-31T23:59:59Z). Defaults to now. examples: - '2026-03-31T23:59:59Z' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardSummaryResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '429': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Too Many Requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable security: - BearerAuth: [] components: schemas: DashboardSummaryResponse: additionalProperties: false properties: avgTimeToReadMinutes: format: double type: - number - 'null' bySender: items: $ref: '#/components/schemas/SenderCountResponse' type: array period: $ref: '#/components/schemas/DateRangeResponse' tenantId: type: string totalReceived: format: int64 type: integer totalUnread: format: int64 type: integer unreadOlderThan15Days: format: int64 type: integer unreadOlderThan3Days: format: int64 type: integer unreadOlderThan7Days: format: int64 type: integer required: - tenantId - totalReceived - totalUnread - avgTimeToReadMinutes - unreadOlderThan3Days - unreadOlderThan7Days - unreadOlderThan15Days - bySender - period type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. required: - correlationId type: object SenderCountResponse: additionalProperties: false properties: count: format: int64 type: integer sender: type: string required: - sender - count type: object DateRangeResponse: additionalProperties: false properties: end: type: string start: type: string required: - start - end type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.