> ## 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.

# Consulta um clique

> Retorna um clique específico da organização pelo seu identificador. Responde 404 se o clique não pertencer à sua organização ou não existir.



## OpenAPI

````yaml /openapi.json get /clicks/{clickId}
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:
  /clicks/{clickId}:
    get:
      tags:
        - Clicks
      summary: Consulta um clique
      description: >-
        Retorna um clique específico da organização pelo seu identificador.
        Responde 404 se o clique não pertencer à sua organização ou não existir.
      operationId: getClick
      parameters:
        - schema:
            type: string
            pattern: ^clk_[0-9A-HJKMNP-TV-Z]{26}$
            example: clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D
          in: path
          name: clickId
          required: true
          description: Identificador do clique.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único do clique.
                    example: clk_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  organizationId:
                    type: string
                    description: Organização dona do clique.
                    example: org_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  programId:
                    type: string
                    description: Programa de afiliados associado ao clique.
                    example: prog_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  affiliateId:
                    type: string
                    description: Afiliado que originou o clique.
                    example: aff_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  linkId:
                    type: string
                    description: Link de afiliado clicado.
                    example: link_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  visitorId:
                    type: string
                    description: Visitante (cookie first-party) que realizou o clique.
                    example: vis_01J9Z3K8YQ4N2T7B6F0X1A2C3D
                  fingerprint:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Impressão digital do dispositivo, quando disponível.
                  ip:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      Endereço IP do visitante, anonimizado por privacidade (ver
                      ipTruncatedAt).
                    example: 203.0.113.0
                  ipTruncatedAt:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    description: >-
                      Data em que o IP foi truncado/anonimizado por privacidade;
                      nulo se não truncado.
                    example: '2026-06-13T12:00:00.000Z'
                  country:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: País resolvido por GeoIP a partir do IP.
                    example: BR
                  region:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Região/estado resolvido por GeoIP.
                    example: SP
                  city:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Cidade resolvida por GeoIP.
                    example: São Paulo
                  userAgent:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: User-agent bruto do clique.
                  device:
                    anyOf:
                      - type: object
                        properties:
                          deviceType:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              Tipo de dispositivo derivado do user-agent (ex.:
                              desktop, mobile, tablet).
                            example: mobile
                          browser:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: Navegador derivado do user-agent.
                            example: Chrome
                          os:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: Sistema operacional derivado do user-agent.
                            example: Android
                        required:
                          - deviceType
                          - browser
                          - os
                        additionalProperties: false
                      - type: 'null'
                    description: Dados de dispositivo derivados do user-agent.
                  referrer:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: URL de origem (referrer) da página onde o clique ocorreu.
                    example: https://blog.exemplo.com/post
                  subId:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Sub-identificador livre (subId) repassado pelo afiliado.
                    example: campanha-natal
                  bot:
                    type: boolean
                    description: Indica se o clique foi classificado como tráfego de bot.
                    example: false
                  botReason:
                    anyOf:
                      - type: string
                        enum:
                          - user_agent
                          - ip_blocklist
                        description: >-
                          Motivo da classificação como bot: `user_agent`
                          (user-agent reconhecido como robô) ou `ip_blocklist`
                          (IP em lista de bloqueio).
                      - type: 'null'
                    description: Motivo da classificação como bot; nulo quando não é bot.
                  source:
                    type: string
                    enum:
                      - redirect
                      - script
                    description: >-
                      Origem do clique: `redirect` (capturado no
                      redirecionamento 302 de /t/{token}) ou `script` (capturado
                      pelo snippet JS via /track/click).
                  convertedAt:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    description: >-
                      Data em que o clique gerou conversão; nulo se ainda não
                      converteu.
                    example: '2026-06-13T12:30:00.000Z'
                  occurredAt:
                    description: Data/hora em que o clique ocorreu (ISO-8601).
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                  expiresAt:
                    description: >-
                      Data de expiração da janela de atribuição do clique: após
                      essa data o clique não pode mais ser creditado a uma
                      conversão.
                    example: '2026-07-13T12:00:00.000Z'
                    type: string
                    format: date-time
                  createdAt:
                    description: Data de criação do registro de clique.
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                required:
                  - id
                  - organizationId
                  - programId
                  - affiliateId
                  - linkId
                  - visitorId
                  - fingerprint
                  - ip
                  - ipTruncatedAt
                  - country
                  - region
                  - city
                  - userAgent
                  - device
                  - referrer
                  - subId
                  - bot
                  - botReason
                  - source
                  - convertedAt
                  - occurredAt
                  - expiresAt
                  - createdAt
                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`.

````