Skip to main content
GET
Comportamento do cliente

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