Skip to main content
GET
Performance do programa de indicação

Performance de Indicação

Retorna métricas agregadas do programa de indicação da empresa no período informado.

Filtros

  • days define janela de análise
  • client_id opcional para filtrar um indicador específico

Status comuns

  • 200 métricas retornadas
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 422 parâmetro inválido

Headers

X-API-Key
string
required

Chave de API

Query Parameters

days
integer
default:30
Required range: 1 <= x <= 365
client_id
string | null

Response

Successful Response

Performance do programa de indicação da empresa.

avg_days_to_convert
number | null
conversion_rate
number
default:0
converted_referrals
integer
default:0
pending_referrals
integer
default:0
period_days
integer
default:30
referrals_by_period
ReferralByPeriod · object[]
top_referrers
ReferralTopReferrer · object[]
total_referrals
integer
default:0