> ## 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. # Volumetria report > Returns COUNT(*) grouped by (messageType, status, day) over the raw message tables within the date range — the per-type/day message breakdown. Non-monetary (counts only). ## OpenAPI ````yaml en/openapi/v3-current/spb.yaml get /v1/str/reports/volumetria openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for Lerian SPB, the direct integration between the institution and the Brazilian Payment System (SPB) over the National Financial System Network (RSFN). It covers the Reserve Transfer System (STR): message registry and capability catalog, operation lifecycle (bank transfers, IBS repasses, liquidity transfers, returns and cancellations), reserve-account and schedule queries, alçada governance, reconciliation, and event delivery. license: name: Lerian Studio General License title: Lerian SPB API version: 1.0.0 servers: - url: https://spb.sandbox.lerian.net security: [] tags: - description: Immutable audit-record trails for STR operations and lifecycle events. name: Audit - description: >- STR capability catalog describing supported message types and their constraints. name: Capabilities - description: >- ICP-Brasil certificate inventory with hot-reloadable rotation and activation. name: Certificates - description: >- Maker-checker approval queue for emissions parked above their alçada band: list pending, sign (approve), and deny. name: EmissionApprovals - description: Webhook event-delivery records with retry control for failed dispatches. name: EventDeliveries - description: Operation event catalog enumerating the emitted domain event types. name: Events - description: >- Inbound GEN-family notice log (GEN0001 connectivity echo, GEN0004 transmission error, GEN0005 administrative notice). name: GenNotices - description: >- SPB alçada governance: the value-band table and per-message-type signature requirements, hot-reloaded at runtime. name: Governance - description: >- Read raw STR message status: list messages and read a single message by NUOp. name: Messages - description: Aggregated operational summaries and metrics across STR operations. name: OperationalIntelligence - description: >- STR operation lifecycle for bank transfers and IBS repasses, including returns and cancellations. name: Operations - description: >- Service readiness state covering startup self-probes and dependency health. name: Readiness - description: Reconciliation cases and the actions that resolve operation discrepancies. name: Reconciliation - description: >- STR reports suite: synchronous, date-ranged aggregate reports (financial movement, rejected transactions, volumetria) over Lerian SPB's own transmission record. name: Reports - description: >- STR0013 reserve-account balance and STR0014 statement (extrato, message-mode) queries and their async results. name: ReserveQueries - description: >- GEN0019 participant responsável roster: full-replacement updates announced to BACEN. name: Responsibles - description: STR operating-window schedule governing when operations may be sent. name: Schedule - description: >- STR0001 single-party schedule queries (consulta de horários do STR) and their async STR0001R1 grid results. name: ScheduleQueries - description: Runtime SPB configuration settings for the STR integration. name: Settings - description: Webhook endpoint registration and management for event delivery. name: Webhooks - description: >- Flow (mandatory order): certificate → readiness → connectivity-test → submit. Activate a certificate, confirm the rail reports ready, pass a connectivity test, then submit an operation. Each step is its own resource; a submit must not be attempted before readiness passes. name: onboarding - description: >- Flow (mandatory order): parent operation SETTLED → return/cancel. A return or cancellation is a sub-resource of a settled parent operation; the {operationId}/{endToEndID} path segment enforces the parent structurally. name: lifecycle paths: /v1/str/reports/volumetria: get: tags: - Reports summary: Volumetria report description: >- Returns COUNT(*) grouped by (messageType, status, day) over the raw message tables within the date range — the per-type/day message breakdown. Non-monetary (counts only). operationId: getReportVolumetria parameters: - description: Inclusive range start (RFC3339 timestamp or YYYY-MM-DD). explode: false in: query name: fromDate required: true schema: description: Inclusive range start (RFC3339 timestamp or YYYY-MM-DD). examples: - '2026-05-01' type: string - description: >- Inclusive range end (RFC3339 timestamp or YYYY-MM-DD). A bare date snaps to end-of-day. explode: false in: query name: toDate required: true schema: description: >- Inclusive range end (RFC3339 timestamp or YYYY-MM-DD). A bare date snaps to end-of-day. examples: - '2026-05-31' type: string - description: Optional STR/LPI message-code filter (e.g. STR0008). explode: false in: query name: messageType schema: description: Optional STR/LPI message-code filter (e.g. STR0008). type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportVolumetriaResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ReportVolumetriaResponse: additionalProperties: false properties: correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string fromDate: description: RFC3339 UTC inclusive lower bound of the queried range. examples: - '2026-05-01T00:00:00Z' type: string rows: description: >- COUNT(*) grouped by (messageType, status, day), ordered by day then messageType then direction then status. items: $ref: '#/components/schemas/ReportVolumetriaRowResponse' type: - array - 'null' toDate: description: RFC3339 UTC inclusive upper bound of the queried range. examples: - '2026-05-31T23:59:59Z' type: string required: - fromDate - toDate - rows - correlationId type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 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 type: object ReportVolumetriaRowResponse: additionalProperties: false properties: count: description: Number of messages in the bucket. examples: - 15 format: int64 type: integer day: description: UTC day bucket (YYYY-MM-DD) of the messages' creation timestamp. examples: - '2026-05-01' type: string direction: description: 'Message direction: OUTBOUND (sent) or INBOUND (received).' examples: - OUTBOUND type: string messageType: description: STR/LPI message code. examples: - STR0008 type: string status: description: Lifecycle status; INBOUND rows carry the synthetic status RECEIVED. examples: - CONFIRMED type: string required: - messageType - status - direction - day - count 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 securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````