Customer KPIs

Monitor your customer base with comprehensive metrics covering customer counts and status distributions. These KPIs provide essential insights for tracking customer growth and retention across your platform.

Available KPIs

Customer Summary

Returns the total count of customers in your platform.

Endpoint

GET /backend/kpi/customers/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "customer_count": 2847
  }
]

Customers by Status

Groups customers by their current status, providing insights into active, suspended, and dropped accounts.

Endpoint

GET /backend/kpi/customers/byStatus/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byStatus/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "customer_status": "Active",
    "customer_count": 2650
  },
  {
    "customer_status": "Suspended",
    "customer_count": 47
  },
  {
    "customer_status": "Dropped",
    "customer_count": 150
  }
]

Customers by Dealer

Groups customers by dealer for account segregation.

Endpoint

GET /backend/kpi/customers/byDealer/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byDealer/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "customer_dealer": "DEALER01",
    "customer_count": 850
  },
  {
    "customer_dealer": "DEALER02",
    "customer_count": 650
  },
  {
    "customer_dealer": "DIRECT",
    "customer_count": 1347
  }
]

Filtering Options

Refine your results using these filter parameters:

Parameter	Type	Description	Example
active	boolean	Include only active customers	active=true
excludeDropped	boolean	Exclude dropped customers (alias for active)	excludeDropped=true
dropped	boolean	Include only dropped customers	dropped=true
dealerCode	string	Filter by specific dealer code	dealerCode=DEALER01

Filter Examples

Active Customers Only

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/?active=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Customers Without Dealer Assignment

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byDealer/?dealerCode=" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Dropped Customers by Dealer

curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byDealer/?dropped=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Use Cases

Monitor Customer Growth

Track overall customer numbers and identify growth trends:

# Get current customer totals
curl -X GET "https://companyname.callstats.net/backend/kpi/customers/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Account Segregation

View customer distribution by dealer:

# All dealers
curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byDealer/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Active customers only
curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byDealer/?active=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Customer Retention Monitoring

Track customer status distributions to identify retention issues:

# Overall status distribution
curl -X GET "https://companyname.callstats.net/backend/kpi/customers/byStatus/" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

# Only dropped customers
curl -X GET "https://companyname.callstats.net/backend/kpi/customers/?dropped=true" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Best Practices

1. Regular Monitoring - Set up automated monitoring of customer counts to detect sudden changes
2. Status Tracking - Monitor suspended and dropped customer ratios as early warning indicators
3. Segmentation - Combine filters to analyse specific customer segments
4. Trend Analysis - Store historical data to identify long-term trends and seasonal patterns

Related KPIs

• Number KPIs - Analyse telephone number allocation per customer
• Feature KPIs - Track feature adoption across your customer base
• Invoice KPIs - Monitor billing performance by customer segment