/api/customer_features

Header

X-Customer-Api-Id: <uuid>
X-Secret: <secret>
Content-Type: application/json

Request Body Schema

today (string, YYYY-MM-DD, optional; defaults to server date)
customers (array, required, ≥ 1)
customer_id (string, required)
loyalty_score (float 0–1, optional; defaults 0.0)
transactions (array, required, ≥ 1)
transaction_id (string, required)
date (string YYYY-MM-DD, required)
amount (float ≥ 0, required)
product_id (string, required)

Example Request Body

{
  "today":"2025-04-24",
  "customers":[
    {
      "customer_id":"C-1001",
      "loyalty_score":0.97,
      "transactions":[
        {"transaction_id":"T-001","date":"2025-04-21","amount":520.55,"product_id":"P-01"},
        {"transaction_id":"T-002","date":"2025-04-18","amount":398.40,"product_id":"P-02"},
        {"transaction_id":"T-003","date":"2025-03-29","amount":310.00,"product_id":"P-01"}
      ]
    }
  ]
}

Example Response Body

{
  "customers":[
    {
      "customer_id":"C-1001",
      "features":{
        "purchase_total":1228.95,
        "visit_frequency":3.0,
        "avg_ticket":409.65,
        "product_diversity":2.0,
        "loyalty_score":0.97,
        "recency_days":3.0
      }
    }
  ]
}

Description

Rolls up each customer’s transactions (and optional loyalty_score) into six KPIs—total spend, visit count, avg ticket, distinct products, loyalty score, and days since last purchase—ready for ML or BI.

Business Usage

• Rapid segmentation via /purchasing_segmentation • CLV or churn models (/customer_clv_forecast, /churn_risk) • Personalized campaigns (e.g. recency_days ≤ 7 ⇒ “Welcome back”) • Loyalty tier upgrades (score > 0.8 + diversity ≥ 10)

← Back to all routes