DocsAPI ReferenceDashboard/bff/dashboard/inactive-customers
getDashboardAdmin BFF

/bff/dashboard/inactive-customers

Identifies customers who have not ordered recently. Perfect input for reactivation campaigns and retention efforts.

DashboardgetBffDashboardInactive-customers

Parameters

1 query

1 total
Query · 1
inactiveDaysnumber

Days without order to be considered inactive. Defaults to 90.

Default: 90

Request

GET /bff/dashboard/inactive-customers

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/inactive-customers?inactiveDays=90" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Inactive customers analysis.

{
  "summary": {
    "totalCustomers": 0,
    "activeCustomers": 0,
    "inactiveCustomers": 0,
    "inactivityRate": 0,
    "inactiveRevenuePotential": 0
  },
  "bySegment": [
    {
      "segment": "example_segment",
      "segmentLabel": "example_segmentLabel",
      "customerCount": 0,
      "avgLifetimeValue": 0,
      "avgOrders": 0
    }
  ],
  "topInactiveCustomers": [
    {
      "customerId": 0,
      "externalId": "example_externalId",
      "customerName": "example_customerName",
      "lastOrderDate": "example_lastOrderDate",
      "orderCount": 0,
      "totalSpent": 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