Skip to main content
GET
/
api
/
v1
/
public
/
referrals
/
metrics
Métricas de indicação
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/referrals/metrics \
  --header 'X-API-Key: <x-api-key>'
{
  "avg_days_to_convert": 123,
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "clients_never_referred": 0,
  "clients_referred_but_inactive": 0,
  "conversion_rate": 0,
  "converted_referrals": 0,
  "expired_referrals": 0,
  "pending_referrals": 0,
  "period_days": 30,
  "referrals_by_period": [
    {
      "period": "<string>",
      "converted": 0,
      "generated": 0
    }
  ],
  "top_referrers": [
    {
      "client_id": "<string>",
      "name": "<string>",
      "conversion_rate": 0,
      "conversions": 0,
      "referrals": 0
    }
  ],
  "total_referrals": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Métricas de Indicação

Retorna métricas agregadas de indicação da empresa. Permite filtrar por campaign_id, período (days) e granularidade (group_by).

Headers

​
X-API-Key
string
required

Chave de API

Query Parameters

​
campaign_id
string<uuid> | null

ID da campanha (null agrega todas)

​
days
integer
default:30
Required range: 1 <= x <= 365
​
group_by
string
default:day

"day", "week" ou "month"

Response

Successful Response

Métricas de performance do programa de indicação.

​
avg_days_to_convert
number | null
​
campaign_id
string | null
​
campaign_name
string | null
​
clients_never_referred
integer
default:0
​
clients_referred_but_inactive
integer
default:0
​
conversion_rate
number
default:0
​
converted_referrals
integer
default:0
​
expired_referrals
integer
default:0
​
pending_referrals
integer
default:0
​
period_days
integer
default:30
​
referrals_by_period
ReferralByPeriod · object[]
​
top_referrers
ReferralMetricsTopReferrer · object[]
​
total_referrals
integer
default:0