CSAT & top/bottom-box API

Computes CSAT (% at/above the satisfied threshold), mean score, top-2-box, bottom-2-box and net-top-box from a frequency distribution of scale responses. Answers 'What is my CSAT and top-2-box?', 'What share of responses are in the bottom box?'.

Price$0.02per request

MethodPOST

Route/v1/stats/csat-top-box

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

surveycsattop-2-boxbottom-2-boxsatisfactioncustomer-experiencelikertdistribution

API URLhttps://x402.hexl.dev/v1/stats/csat-top-box

Integration docs

Example request

{
  "counts": [
    5,
    10,
    15,
    40,
    30
  ]
}

Example response

{
  "csatPercent": 70,
  "meanScore": 3.8,
  "topBoxPercent": 70,
  "bottomBoxPercent": 15,
  "netTopBox": 55,
  "total": 100,
  "scaleRange": [
    1,
    5
  ],
  "satisfiedThreshold": 4,
  "interpretation": "moderate satisfaction"
}

Input schema

{
  "type": "object",
  "required": [
    "counts"
  ],
  "properties": {
    "counts": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "frequency per scale point, low to high",
      "examples": [
        [
          5,
          10,
          15,
          40,
          30
        ]
      ]
    },
    "scaleMin": {
      "type": "integer",
      "default": 1
    },
    "satisfiedThreshold": {
      "type": "integer",
      "description": "min value counted as satisfied"
    },
    "topBox": {
      "type": "integer",
      "default": 2
    },
    "bottomBox": {
      "type": "integer",
      "default": 2
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}