Catalog/psy-net-promoter-score

Statistics

Net Promoter Score (NPS) API

Computes Net Promoter Score as (%promoters - %detractors) from promoter/passive/detractor counts, or by bucketing a raw array of 0-10 ratings, with category percentages and a benchmark verdict. Answers 'What is my NPS?', 'How do my 0-10 ratings translate into promoters and detractors?'.

Price$0.02per request
MethodPOST
Route/v1/stats/net-promoter-score
StatusLive
MIME typeapplication/json
Rate limit120/minute
Cache0s public
surveynpsnet-promoter-scorecustomer-experienceloyaltypromoterdetractorcx
API URLhttps://x402.hexl.dev/v1/stats/net-promoter-score
Integration docs
Example request
{
  "promoters": 70,
  "passives": 20,
  "detractors": 10
}
Example response
{
  "nps": 60,
  "promoters": 70,
  "passives": 20,
  "detractors": 10,
  "total": 100,
  "pctPromoters": 70,
  "pctPassives": 20,
  "pctDetractors": 10,
  "interpretation": "excellent"
}
Input schema
{
  "type": "object",
  "properties": {
    "promoters": {
      "type": "integer",
      "examples": [
        70
      ]
    },
    "passives": {
      "type": "integer",
      "examples": [
        20
      ]
    },
    "detractors": {
      "type": "integer",
      "examples": [
        10
      ]
    },
    "ratings": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "alternative: raw 0-10 ratings"
    }
  }
}
Output schema
{
  "type": "object",
  "additionalProperties": true
}