> ## Documentation Index
> Fetch the complete documentation index at: https://juridiqsoftware.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Métricas de parceiros financeiros



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /metrics/partners
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /metrics/partners:
    get:
      tags:
        - Metrics
      summary: Métricas de parceiros financeiros
      parameters:
        - schema:
            allOf:
              - type: string
              - type: string
                pattern: ^\d{4}-\d{2}-\d{2}$
          in: query
          name: startDate
          required: true
          description: Início do período (YYYY-MM-DD)
        - schema:
            allOf:
              - type: string
              - type: string
                pattern: ^\d{4}-\d{2}-\d{2}$
          in: query
          name: endDate
          required: true
          description: Fim do período (YYYY-MM-DD)
        - schema:
            type: string
            enum:
              - day
              - week
              - month
              - custom
          in: query
          name: periodType
          required: false
        - schema:
            type: string
            format: uuid
          in: query
          name: partnerId
          required: false
          description: Filtra métricas deste parceiro
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalPartners:
                    type: number
                    description: Parceiros cadastrados (snapshot)
                  linkedLawsuitsCount:
                    type: number
                    description: Processos com parceiro vinculado (snapshot)
                  commissionPending:
                    type: number
                    description: Comissão a pagar (não paga)
                  commissionPaidByMonth:
                    type: array
                    items:
                      type: object
                      properties:
                        month:
                          type: string
                          description: YYYY-MM
                        label:
                          type: string
                          description: Mês abreviado
                        amount:
                          type: number
                          description: Comissão paga no mês
                      required:
                        - month
                        - label
                        - amount
                      additionalProperties: false
                    description: Últimos 6 meses até endDate
                  lawsuitsByPartner:
                    type: array
                    items:
                      type: object
                      properties:
                        partnerId:
                          type: string
                          format: uuid
                        partnerName:
                          type: string
                        lawsuitsCount:
                          type: number
                      required:
                        - partnerId
                        - partnerName
                        - lawsuitsCount
                      additionalProperties: false
                    description: Ranking atual de processos vinculados
                required:
                  - totalPartners
                  - linkedLawsuitsCount
                  - commissionPending
                  - commissionPaidByMonth
                  - lawsuitsByPartner
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

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