BizKitHub
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

Query parameters

· 1
monthsnumberOptional

Number of months to analyze. Defaults to 6.

Default: 6
Example6

Response schema

1 status code documented

200SuccessCustomer segmentation analysis.
currentMonthobjectRequired

Current month customer breakdown.

newCustomersnumberRequired

Customers making their first-ever order this month.

returningCustomersnumberRequired

Customers with at least one previous order.

newCustomerRevenuenumberRequired

Revenue from new customers.

returningCustomerRevenuenumberRequired

Revenue from returning customers.

newCustomerPercentagenumberRequired

Percentage of customers who are new (0-100).

previousMonthobjectRequired

Previous month for comparison.

newCustomersnumberRequired

New customers in previous month.

returningCustomersnumberRequired

Returning customers in previous month.

newCustomerPercentagenumberRequired

New customer percentage in previous month.

monthlyTrendobject[]Required

Monthly trend data, oldest first.

Each array item:

Monthly customer segmentation data point.

monthstringRequired

Month in YYYY-MM format.

newCustomersnumberRequired

New customers count.

returningCustomersnumberRequired

Returning customers count.

newCustomerPercentagenumberRequired

Percentage of new customers (0-100).

currencystringRequired

Currency code for revenue amounts (e.g., "CZK").

Response example

application/json
{
  "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"
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key