> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Bank Account Metrics

> Get settled and failed totals for in, out and transfer documents



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/metrics
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/bank_accounts/{id}/metrics:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          ID of another org to act on instead of the API key's own org. The
          key's org must have been granted access to it, and the request is
          refused with 403 FORBIDDEN otherwise. When that access or the API key
          is read-only, only GET and HEAD requests may carry it. When the target
          org requires mTLS, so does the request. Leave it out to act on the
          key's own org.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    get:
      tags:
        - Bank Accounts
        - Metrics
      summary: Get bank account metrics
      description: Get settled and failed totals for in, out and transfer documents
      operationId: TrioFoundationWeb.V2.BankAccount.MetricController.index
      parameters:
        - description: Bank account ID
          in: path
          name: id
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - description: From datetime
          in: query
          name: from_datetime
          required: true
          schema:
            $ref: '#/components/schemas/DATETIME'
        - description: To datetime
          in: query
          name: to_datetime
          required: true
          schema:
            $ref: '#/components/schemas/DATETIME'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_bank_account_metrics_response'
          description: Metrics
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: No resource with this ID (NOT_FOUND_RESOURCE).
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    UUID:
      description: Unique identifier
      format: uuid
      title: UUID
      type: string
      x-struct: null
      x-validate: null
    DATETIME:
      description: Datetime schema
      format: date-time
      title: DATETIME
      type: string
      x-struct: null
      x-validate: null
    V2_bank_account_metrics_response:
      description: Bank account metrics response
      example:
        data:
          in_documents:
            failed: 2
            settled: 12
          out_documents:
            failed: 1
            settled: 8
          transfer_documents:
            failed: 0
            settled: 3
      properties:
        data:
          $ref: '#/components/schemas/V2_bank_account_metrics'
      title: V2 bank account metrics response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.Response
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
    V2_bank_account_metrics:
      description: Settled and failed totals by document type
      example:
        in_documents:
          failed: 2
          settled: 12
        out_documents:
          failed: 1
          settled: 8
        transfer_documents:
          failed: 0
          settled: 3
      properties:
        in_documents:
          $ref: '#/components/schemas/V2_bank_account_document_metrics'
        out_documents:
          $ref: '#/components/schemas/V2_bank_account_document_metrics'
        transfer_documents:
          $ref: '#/components/schemas/V2_bank_account_document_metrics'
      title: V2 bank account metrics
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.MetricData
      x-validate: null
    V2_bank_account_document_metrics:
      description: Settled and failed document counts
      example:
        failed: 2
        settled: 12
      properties:
        failed:
          description: Failed count
          minimum: 0
          type: integer
          x-struct: null
          x-validate: null
        settled:
          description: Settled count
          minimum: 0
          type: integer
          x-struct: null
          x-validate: null
      title: V2 bank account document metrics
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.BankAccount.Metric.DocumentCounts
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.