Skip to main content
GET
/
api
/
v1
/
public
/
loyalty-cards
/
metrics
Métricas de cartão de fidelidade
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/loyalty-cards/metrics \
  --header 'X-API-Key: <x-api-key>'
{
  "avg_days_to_complete": 123,
  "avg_stamps_per_active_card": 0,
  "cards_active": 0,
  "cards_completed": 0,
  "cards_issued": 0,
  "cards_near_completion": 0,
  "clients_with_card": 0,
  "clients_without_card": 0,
  "completion_rate": 0,
  "period_days": 30,
  "program_id": "<string>",
  "program_name": "<string>",
  "stamps_by_period": [
    {
      "period": "<string>",
      "completions": 0,
      "stamps": 0
    }
  ],
  "top_clients": [
    {
      "client_id": "<string>",
      "name": "<string>",
      "cards_completed": 0,
      "stamps_total": 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 Cartão

Retorna métricas de cartões de fidelidade por programa ou no agregado da empresa.

​
Filtros

  • program_id opcional para visão de programa específico
  • days para janela temporal
  • group_by: day, week ou month

​
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

​
program_id
string<uuid> | null

ID do programa (null agrega todos)

​
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 de programas de cartão de fidelidade.

​
avg_days_to_complete
number | null
​
avg_stamps_per_active_card
number
default:0
​
cards_active
integer
default:0
​
cards_completed
integer
default:0
​
cards_issued
integer
default:0
​
cards_near_completion
integer
default:0
​
clients_with_card
integer
default:0
​
clients_without_card
integer
default:0
​
completion_rate
number
default:0
​
period_days
integer
default:30
​
program_id
string | null
​
program_name
string | null
​
stamps_by_period
LoyaltyStampsByPeriod · object[]
​
top_clients
LoyaltyTopClient · object[]