API ReferenceShare Feedback

Get aggregated PREM metrics

View as MarkdownOpen in Claude

Returns aggregated satisfaction metrics for the operator’s organisation across the requested reporting window. Includes total responses, average rating, low-score and high-score counts, and the per-rating distribution. Use this endpoint for dashboard summary tiles; use the list endpoint to drill into individual responses.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

periodStartstringOptional

ISO 8601 lower bound for the reporting window. Defaults to the start of time (epoch).

periodEndstringOptional
ISO 8601 upper bound for the reporting window. Defaults to now.

Response

Aggregated PREM metrics.
totalResponsesdouble
Total number of PREM responses recorded within the reporting window.
averageRatingdouble

Mean satisfaction rating across all responses (1-5), rounded to one decimal place.

lowScoreCountdouble
Number of responses with a rating of 2 or below.
highScoreCountdouble
Number of responses with a rating of 4 or above.
ratingDistributionmap from strings to integers

Distribution of ratings across 1-5. Keys are numeric strings (1..5) mapping to the count of responses at that rating.