Skip to main content
GET
/
api
/
v1
/
public
/
metrics
/
overview
KPIs da empresa
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/metrics/overview \
  --header 'X-API-Key: <x-api-key>'
{
  "total_clients": 342,
  "active_clients_30d": 128,
  "total_points_distributed": 85200,
  "total_points_redeemed": 42600,
  "total_coupons_generated": 215,
  "total_coupons_used": 189,
  "total_loyalty_cards": 156,
  "completed_loyalty_cards": 47,
  "total_referrals": 89,
  "period": "all_time",
  "generated_at": "2026-03-20T12:00:00Z"
}

​
Visão Geral de Métricas

Retorna KPIs resumidos da operação de fidelização da empresa, incluindo clientes, pontos, cupons e cartões.

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/metrics/overview" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "total_clients": 342,
  "active_clients_30d": 128,
  "total_points_distributed": 85200,
  "total_points_redeemed": 42600,
  "total_coupons_generated": 215,
  "total_coupons_used": 189,
  "total_loyalty_cards": 156,
  "completed_loyalty_cards": 47,
  "total_referrals": 89,
  "period": "all_time",
  "generated_at": "2026-03-20T12:00:00Z"
}

​
Campos da Resposta

​
total_clients
integer
Total de clientes cadastrados
​
active_clients_30d
integer
Clientes com atividade nos últimos 30 dias
​
total_points_distributed
integer
Total de pontos distribuídos (histórico completo)
​
total_points_redeemed
integer
Total de pontos resgatados
​
total_coupons_generated
integer
Total de cupons gerados
​
total_coupons_used
integer
Total de cupons utilizados
​
total_loyalty_cards
integer
Total de cartões fidelidade criados
​
completed_loyalty_cards
integer
Cartões fidelidade completados
​
total_referrals
integer
Total de indicações registradas
​
period
string
Período das métricas (atualmente all_time)
​
generated_at
string
Timestamp de geração das métricas (ISO 8601)

Headers

​
X-API-Key
string
required

Chave de API da empresa

Response

Successful Response

KPIs resumidos da empresa.

​
active_clients
integer
default:0
​
total_clients
integer
default:0
​
total_coupons
integer
default:0
​
total_points_distributed
integer
default:0
​
total_rewards_claimed
integer
default:0