> ## 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 operational aggregates

> Returns pre-computed aggregate buckets matching the requested window (hour or day) + date range. Source is the operational_aggregate_bucket table populated by a background worker. Buckets are ordered by bucket_start ASC.



## OpenAPI

````yaml en/openapi/v3-current/spb.yaml get /v1/str/operational-aggregates
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/operational-aggregates:
    get:
      tags:
        - OperationalIntelligence
      summary: Get operational aggregates
      description: >-
        Returns pre-computed aggregate buckets matching the requested window
        (hour or day) + date range. Source is the operational_aggregate_bucket
        table populated by a background worker. Buckets are ordered by
        bucket_start ASC.
      operationId: getOperationalAggregates
      parameters:
        - description: 'Aggregation window: ''hour'' or ''day''.'
          explode: false
          in: query
          name: window
          required: true
          schema:
            description: 'Aggregation window: ''hour'' or ''day''.'
            examples:
              - hour
            type: string
        - description: Inclusive start (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: startDate
          required: true
          schema:
            description: Inclusive start (RFC3339 timestamp or YYYY-MM-DD).
            examples:
              - '2026-06-14T12:00:00Z'
            type: string
        - description: Inclusive end (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: endDate
          required: true
          schema:
            description: Inclusive end (RFC3339 timestamp or YYYY-MM-DD).
            examples:
              - '2026-06-14T12:00:00Z'
            type: string
        - description: Optional operation family filter.
          explode: false
          in: query
          name: operationFamily
          schema:
            description: Optional operation family filter.
            type: string
        - description: Optional lifecycle status filter.
          explode: false
          in: query
          name: status
          schema:
            description: Optional lifecycle status filter.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationalAggregatesResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    OperationalAggregatesResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          examples:
            - req-7a3f9c2e
          type: string
        endDate:
          description: RFC3339 UTC inclusive upper bound of the queried range.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        items:
          description: >-
            Aggregate buckets ordered by bucket_start ascending; empty until the
            aggregation worker has populated data.
          items:
            $ref: '#/components/schemas/OperationalAggregateBucketResponse'
          type:
            - array
            - 'null'
        startDate:
          description: RFC3339 UTC inclusive lower bound of the queried range.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        window:
          description: 'Aggregation window applied to the buckets: ''hour'' or ''day''.'
          examples:
            - hour
          type: string
      required:
        - window
        - startDate
        - endDate
        - items
        - correlationId
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    OperationalAggregateBucketResponse:
      additionalProperties: false
      properties:
        bucketEnd:
          description: RFC3339 UTC timestamp of the bucket's exclusive upper bound.
          examples:
            - '2026-06-14T13:00:00Z'
          type: string
        bucketStart:
          description: RFC3339 UTC timestamp of the bucket's inclusive lower bound.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        count:
          description: Number of operations falling in this bucket.
          examples:
            - 24
          format: int64
          type: integer
        operationFamily:
          description: >-
            Operation family this bucket aggregates; omitted when the bucket is
            not family-scoped.
          type: string
        status:
          description: >-
            Lifecycle status this bucket aggregates; omitted when the bucket is
            not status-scoped.
          type: string
      required:
        - bucketStart
        - bucketEnd
        - 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

````