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

# Comparação do período atual vs anterior

> Compara o período atual com a janela anterior espelhada `[from−(to−from), from)`. `revenue` soma conversões não-voided (distinto da receita atribuída do herói, que soma comissões). `series` traz a receita (conversões) em 5 fatias alinhadas por índice.



## OpenAPI

````yaml /openapi.json get /dashboard/period-comparison
openapi: 3.1.0
info:
  title: Repass API
  description: >-
    API pública do Repass — plataforma de gestão de afiliados: programas, links,
    tracking, atribuição, conversões, comissões, payouts, fiscal (BR),
    reprocessamento, event store e webhooks.
  version: 0.1.0
servers:
  - url: https://api.userepass.com
    description: Produção
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Profile
    description: Perfil do usuário autenticado.
  - name: Guide
    description: >-
      Guia de onboarding do painel: estado de tours, telas visitadas e
      preferências por usuário e organização.
  - name: Portal
    description: >-
      Portal do afiliado: sessão por identidade de afiliado (sem org), convites
      e claim.
  - name: Programs
    description: 'Programas de afiliados: configuração, atribuição, hold e tiers.'
  - name: Commission Rules
    description: Regras de comissão versionadas (imutáveis) por programa.
  - name: Affiliates
    description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.'
  - name: Terms
    description: Termos do programa, versionados.
  - name: Materials
    description: >-
      Materiais (criativos) do programa: upload pelo gestor e download pelos
      afiliados.
  - name: Links
    description: Links rastreáveis e domínios de redirecionamento.
  - name: Coupons
    description: Cupons de afiliado e sync com gateway.
  - name: Pagamentos por PIX
    description: Habilitação de pagamentos por PIX (onboarding e documentos).
  - name: Tracking
    description: Endpoints públicos de redirect e registro de cliques.
  - name: Clicks
    description: Consulta de cliques e estatísticas de link.
  - name: Conversions
    description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.'
  - name: Commissions
    description: Comissões calculadas, holds, aprovação, void e clawback.
  - name: Payouts
    description: Ciclos de pagamento, prévia, execução e comprovantes.
  - name: Invoices
    description: Notas fiscais (PJ), envio e validação (BR).
  - name: Fraud
    description: Fila de revisão e decisões de fraude.
  - name: Reprocess
    description: Reprocessamento com dry-run obrigatório e relatório de impacto.
  - name: Events
    description: Histórico de eventos para auditoria e consulta.
  - name: Notifications
    description: >-
      Notificações ao operador (falhas de sincronização, payouts e afins) —
      registro in-app espelhado por e-mail aos owners/admins.
  - name: Webhooks
    description: Endpoints de webhook, entregas, retries e dead-letter.
  - name: Ingest
    description: Ingestão de eventos de cobrança (S2S e gateways).
  - name: Settings
    description: Configurações por organização (políticas e integrações).
  - name: Billing
    description: 'Plano e cobrança: contadores de uso da organização para o painel.'
  - name: Dashboard
    description: >-
      Métricas agregadas da operação (receita, top afiliados, conversões,
      comissões, novos afiliados) para a home e os relatórios do gestor.
  - name: Health
    description: Liveness do serviço.
paths:
  /dashboard/period-comparison:
    get:
      tags:
        - Dashboard
      summary: Comparação do período atual vs anterior
      description: >-
        Compara o período atual com a janela anterior espelhada
        `[from−(to−from), from)`. `revenue` soma conversões não-voided (distinto
        da receita atribuída do herói, que soma comissões). `series` traz a
        receita (conversões) em 5 fatias alinhadas por índice.
      operationId: getDashboardPeriodComparison
      parameters:
        - schema:
            default: 30d
            type: string
            enum:
              - 30d
              - 90d
              - ytd
            example: 30d
          in: query
          name: period
          required: false
          description: >-
            Janela do dashboard. `30d`: últimos 30 dias (buckets diários).
            `90d`: 90 dias (semanais). `ytd`: ano corrente (mensais).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                    enum:
                      - 30d
                      - 90d
                      - ytd
                    description: >-
                      Janela do dashboard. `30d`: últimos 30 dias (buckets
                      diários). `90d`: 90 dias (semanais). `ytd`: ano corrente
                      (mensais).
                    example: 30d
                  metrics:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          enum:
                            - revenue
                            - conversions
                            - commissions
                            - newAffiliates
                          description: >-
                            `revenue`: soma de conversões não-voided (renomeado
                            do artefato legado "mrr").
                        currentValue:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Valor no período atual (centavos ou contagem).
                        previousValue:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Valor na janela anterior espelhada.
                        deltaBps:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: >-
                            Variação atual×anterior em basis points (convenção
                            de revenue-timeseries).
                      required:
                        - key
                        - currentValue
                        - previousValue
                        - deltaBps
                      additionalProperties: false
                  series:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                          description: Rótulo do bucket (ISO do início da fatia).
                        currentCents:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Receita atribuída (conversões) no bucket atual.
                        previousCents:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Receita atribuída no bucket anterior.
                      required:
                        - label
                        - currentCents
                        - previousCents
                      additionalProperties: false
                    description: 5 fatias de receita atribuída, alinhadas por índice.
                required:
                  - period
                  - metrics
                  - series
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer
        rstr_...`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`.

````