DocsAPI ReferenceDashboard/bff/dashboard/customer-segmentation
getDashboardAdmin BFF

/bff/dashboard/customer-segmentation

Returns customer segmentation showing new vs returning customer ratio. Essential for understanding growth vs retention balance and marketing effectiveness.

DashboardgetBffDashboardCustomer-segmentation

Parameters

1 query

1 total
Query · 1
monthsnumber

Number of months to analyze. Defaults to 6.

Default: 6

Request

GET /bff/dashboard/customer-segmentation

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/customer-segmentation?months=6" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Customer segmentation analysis.

{
  "currentMonth": {
    "newCustomers": 0,
    "returningCustomers": 0,
    "newCustomerRevenue": 0,
    "returningCustomerRevenue": 0,
    "newCustomerPercentage": 0
  },
  "previousMonth": {
    "newCustomers": 0,
    "returningCustomers": 0,
    "newCustomerPercentage": 0
  },
  "monthlyTrend": [
    {
      "month": "example_month",
      "newCustomers": 0,
      "returningCustomers": 0,
      "newCustomerPercentage": 0
    }
  ],
  "currency": "example_currency"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key