Skip to main content
GET
/
api
/
v1
/
public
/
clients
/
{client_id}
/
behavior
Comportamento do cliente
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/clients/{client_id}/behavior \
  --header 'X-API-Key: <x-api-key>'
{
  "client_id": "<string>",
  "coupons_used_period": 0,
  "days_since_last_activity": 123,
  "last_purchase_at": "2023-11-07T05:31:56Z",
  "last_redemption_at": "2023-11-07T05:31:56Z",
  "last_referral_at": "2023-11-07T05:31:56Z",
  "loyalty_cards": [
    {
      "card_id": "<string>",
      "completed": false,
      "max_stamps": 0,
      "stamps": 0
    }
  ],
  "points_balance": 0,
  "points_earned_period": 0,
  "points_redeemed_period": 0,
  "referrals_converted_period": 0,
  "referrals_generated_period": 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.

​
Comportamento do Cliente

Retorna uma visão consolidada do comportamento de um cliente no período solicitado.

​
Principais campos

  • saldo de pontos
  • pontos ganhos e resgatados no período
  • cupons usados no período
  • resumo de cartões de fidelidade
  • última atividade

​
Status comuns

  • 200 cliente encontrado e retorno consolidado
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 404 cliente não encontrado na empresa da key

Headers

​
X-API-Key
string
required

Chave de API

Path Parameters

​
client_id
string
required

Query Parameters

​
days
integer
default:90
Required range: 1 <= x <= 365

Response

Successful Response

Comportamento agregado de um cliente na empresa.

​
client_id
string
required
​
coupons_used_period
integer
default:0
​
days_since_last_activity
integer | null
​
last_purchase_at
string<date-time> | null
​
last_redemption_at
string<date-time> | null
​
last_referral_at
string<date-time> | null
​
loyalty_cards
ClientLoyaltyCardSummary · object[]
​
points_balance
integer
default:0
​
points_earned_period
integer
default:0
​
points_redeemed_period
integer
default:0
​
referrals_converted_period
integer
default:0
​
referrals_generated_period
integer
default:0