API atual/Referência completa/CRM: audiências e RFM

Resumo RFM

Distribui os clientes do seller em 11 segmentos RFM (recência, frequência e valor) e soma receita e pedidos de cada um.

RFM é uma técnica clássica de CRM: cada cliente recebe uma nota de 1 a 5 em Recência (há quanto tempo comprou), Frequência (quantas vezes) e Monetário (quanto gastou), calculada em quintis sobre os pedidos realizados do seu seller. A combinação recência x frequência cai em um dos 11 segmentos abaixo. Use a distribuição para decidir a quem falar primeiro, ou use o segmento como condição rfm_segment de uma audiência.

GET/api/v1/vendor/crm/rfm/summarySeller

Distribuição RFM dos clientes

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/crm/rfm/summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Distribuição

json

{
  "total_customers": 7185,
  "segments": [
    {
      "segment": "champions",
      "customers": 2061,
      "revenue_cents": 1864480258,
      "avg_orders": 13.43
    },
    {
      "segment": "loyal",
      "customers": 30,
      "revenue_cents": 16654613,
      "avg_orders": 7.57
    },
    {
      "segment": "lost",
      "customers": 0,
      "revenue_cents": 0,
      "avg_orders": 0
    }
  ]
}

Campos da resposta

total_customersinteger

Clientes com pelo menos um pedido realizado no escopo do seller.

segmentsarray

Sempre os 11 segmentos, nesta ordem, com zero nos vazios: champions, loyal, potential_loyalist, new_customers, promising, need_attention, at_risk, cant_lose, hibernating, about_to_sleep, lost.

segments[].segmentstring

Rótulo do segmento.

segments[].customersinteger

Clientes no segmento.

segments[].revenue_centsinteger

Soma do gasto dos clientes do segmento, em centavos.

segments[].avg_ordersnumber

Média de pedidos por cliente no segmento.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário tem papel de seller, mas não está ligado a nenhum seller.	`{"error":"vendor profile not found"}`
403	O módulo `crm` está desligado nesta loja.	`{"error":"module_disabled","module":"crm"}`
500	Falha ao calcular.	`{"error":"failed to compute RFM summary"}`

Veja também