Skip to main content

GetDistribution retrieves rating distribution statistics.

GET 

/api/v1/voice/ratings/distribution

Returns count of each rating value for analysis.

Parameters

  • scale_type: Required, rating scale to query

Response

  • distribution: Map of rating value → count
  • total: Total number of ratings
  • average: Average rating value
  • sentiment: Overall sentiment (based on average)
  • nps_score: NPS score (-100 to +100, only for NPS)

Errors

  • PERMISSION_DENIED: Caller lacks voice:rating:read permission

Request

Responses

A successful response.