Collection KPIs

Measure how well your automated collections are performing. Collection KPIs report the collections due in a period alongside how many were collected, how many failed, and the amounts involved.

There are two collection categories, one per collection method:

• directDebitCollections - Direct Debit collections, including how many needed a retry
• cardCollections - saved payment card collections

Both offer the same KPI types, dimensions and filters, and both return their results in collection_ prefixed columns.

Available KPIs

Collection Summary

Returns overall collection totals and outcomes.

Endpoint

GET /backend/kpi/directDebitCollections/
GET /backend/kpi/cardCollections/

Example Request

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

Example Response

[
  {
    "collection_customer_count": 1850,
    "collection_count": 2250,
    "collection_amount": 61500.000,
    "collection_collected_count": 2180,
    "collection_collected_amount": 59750.000,
    "collection_failed_count": 45,
    "collection_failed_amount": 1180.000,
    "collection_retried_count": 62
  }
]

Card collections return the same columns except collection_retried_count, which only applies to Direct Debit.

Collections by Status

Groups collections by their current status.

Endpoint

GET /backend/kpi/directDebitCollections/byStatus/
GET /backend/kpi/cardCollections/byStatus/

Example Request

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

Collections by Dealer

Groups collections by dealer for segmentation and comparison.

Endpoint

GET /backend/kpi/directDebitCollections/byDealer/
GET /backend/kpi/cardCollections/byDealer/

Collections by Month

Tracks collection performance over time.

Endpoint

GET /backend/kpi/directDebitCollections/byMonth/
GET /backend/kpi/cardCollections/byMonth/

Example Request

curl -X GET "https://companyname.callstats.net/backend/kpi/directDebitCollections/byMonth/?minDate=2026-01-01" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Example Response

[
  {
    "collection_month": "2026-05",
    "collection_customer_count": 1830,
    "collection_count": 2210,
    "collection_amount": 60100.000,
    "collection_collected_count": 2145,
    "collection_collected_amount": 58400.000,
    "collection_failed_count": 52,
    "collection_failed_amount": 1350.000,
    "collection_retried_count": 71
  }
]

Flexible Grouping

Combine the collection dimensions (period, status, dealer) with groupBy and pick an interval:

# Weekly Direct Debit collection outcomes by dealer
curl -X GET "https://companyname.callstats.net/backend/kpi/directDebitCollections/?groupBy=period,dealer&interval=week" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

With groupBy, the period column is named collection_period rather than collection_month. Periods are bucketed by each collection’s due date.

Filtering Options

Refine your results using these filter parameters:

Parameter	Type	Description	Example
minDate	date	Collections due on or after	minDate=2026-01-01
maxDate	date	Collections due on or before	maxDate=2026-01-31
status	string	Filter by collection status name	status=Collected
statusID	integer list	Filter by one or more status IDs	statusID=1,2
dealer	string	Filter by dealer name	dealer=Direct
dealerCode	string	Filter by specific dealer code	dealerCode=DEALER01
currencyID	integer list	Filter by currency	currencyID=1

Direct Debit collections and card collections use separate status lists, so the same statusID means different things in each category. Filter by status name where you are unsure, or look the IDs up for the category you are querying.

Filter Examples

This Month’s Collection Run

curl -X GET "https://companyname.callstats.net/backend/kpi/directDebitCollections/?minDate=2026-07-01&maxDate=2026-07-31" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Use Cases

Collection Success Rate

Track collected against failed amounts month by month, per collection method:

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

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

Failure Investigation

When failures rise, break the picture down by status and dealer:

curl -X GET "https://companyname.callstats.net/backend/kpi/directDebitCollections/byStatus/?minDate=2026-06-01" \
  -H "Authorization: Bearer YOUR_KPI_KEY"

Best Practices

1. Watch the failure ratio - Failed against total collections is your headline collection health figure, for both methods
2. Track retries - A rising Direct Debit retry count often precedes a rise in outright failures
3. Compare with payments - The Payment KPIs show collections in the context of all money received
4. Bound by due date - minDate and maxDate filter on the collection due date, so align them with your collection runs

Related KPIs

• Payment KPIs - All amounts received, including Direct Debit and card
• Invoice KPIs - The billing these collections settle
• Debt Ageing KPIs - What failed collections leave outstanding