BizKitHub
DocsAPI ReferenceContact Credit/bff/contact-credit/care-status
getContact CreditAdmin BFF

/bff/contact-credit/care-status

Returns the number of customer-care credits (reklamace / kompenzace / omluva) the contact has received in the last 365 days, alongside the organisation-wide baseline (p75/p90/p95 of care-events per credited contact). The tier is derived by comparing the count to the baseline: 'ok' (no penalty), 'watch' (≥ p75, −3 to score), 'elevated' (≥ p90, −8), 'flag' (≥ p95, −15). When baseline.enabled is false the org has too few care events to compute meaningful thresholds and the tier is always 'ok'.

Contact CreditgetBffContact-creditCare-status

Parameters

1 query

Query parameters

· 1
customerIdstringRequired

Contact external ID.

Exampleabc123def456ghij

Response schema

1 status code documented

200Success
countnumberRequired

Care events for this contact in the last 365 days.

Examples0312
tier"ok" | "watch" | "elevated" | "flag"Required

Retention tier — see endpoint description.

scorePenaltynumberRequired

Score adjustment currently applied for this care-count (0 for ok, negative otherwise).

Examples0-3-8-15
baselineobjectRequired
enabledbooleanRequired

True when the org has enough care events for the percentiles to be meaningful.

sampleSizenumberRequired

Total care events in the org over the window.

contactCountnumberRequired

Distinct contacts who received a care event in the window.

p75numberRequired

Watch threshold (care events per contact).

Example2
p90numberRequired

Elevated threshold (care events per contact).

Example5
p95numberRequired

Flag threshold (care events per contact).

Example9
computedAtstringRequired

Timestamp the baseline was materialized.

windowDaysnumberRequired

Sliding window length in days.

Example365

Response example

application/json
{
  "count": 0,
  "scorePenalty": 0,
  "baseline": {
    "enabled": false,
    "sampleSize": 0,
    "contactCount": 0,
    "p75": 2,
    "p90": 5,
    "p95": 9,
    "computedAt": "example_computedAt",
    "windowDays": 365
  }
}

Request example

GET /bff/contact-credit/care-status

get
curl -X GET "https://api.bizkithub.com/bff/contact-credit/care-status?customerId=abc123def456ghij" \
  -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