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

# Estatísticas da aplicação

> Métricas agregadas de autorizações e uso da aplicação OAuth.

Permissão: `oauth-apps/stats`.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/oauth-apps/stats/clx_app_01' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Estatísticas da aplicação OAuth",
    "data": {
      "activeAuthorizations": 3,
      "totalAuthorizations": 5,
      "lastAuthorizationAt": "2026-09-03T18:00:00.000Z",
      "lastTokenUsedAt": "2026-09-03T19:30:00.000Z",
      "byEnvironment": {
        "DEV": 1,
        "PRODUCTION": 2
      }
    },
    "requestId": "req_oauth_stats"
  }
  ```
</ResponseExample>

### Parâmetros

<ParamField path="id" type="string" required>
  ID da aplicação OAuth.
</ParamField>

### Campos da resposta (`data`)

| Campo                  | Descrição                                    |
| ---------------------- | -------------------------------------------- |
| `activeAuthorizations` | Autorizações com status `ACTIVE`             |
| `totalAuthorizations`  | Total incluindo revogadas                    |
| `lastAuthorizationAt`  | Última conta que autorizou o app             |
| `lastTokenUsedAt`      | Último uso de access token deste app         |
| `byEnvironment`        | Autorizações ativas por `DEV` / `PRODUCTION` |


## OpenAPI

````yaml GET /oauth-apps/stats/{id}
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: oauth
    description: OAuth 2.0 — autorização de terceiros (fora do prefixo /v1)
  - name: oauth-apps
    description: Gestão de aplicações OAuth (prefixo /v1, API key)
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /oauth-apps/stats/{id}:
    get:
      tags:
        - oauth-apps
      summary: Estatísticas da aplicação
      description: Métricas de autorizações ativas e uso. Permissão `oauth-apps/stats`.
      operationId: oauthAppsStats
      parameters:
        - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/OAuthAppsStatsSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ResourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do recurso (transação, cobrança, webhook, etc.)
  responses:
    OAuthAppsStatsSuccess:
      description: Métricas agregadas de autorizações.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicOAuth2ApplicationStats'
              requestId:
                type: string
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    PublicOAuth2ApplicationStats:
      type: object
      required:
        - activeAuthorizations
        - totalAuthorizations
        - byEnvironment
      properties:
        activeAuthorizations:
          type: integer
        totalAuthorizations:
          type: integer
        lastAuthorizationAt:
          type: string
          format: date-time
          nullable: true
        lastTokenUsedAt:
          type: string
          format: date-time
          nullable: true
        byEnvironment:
          type: object
          properties:
            DEV:
              type: integer
            PRODUCTION:
              type: integer
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````