Skip to main content
GET
/
projects
/
{project_id}
/
ratings
/
stats
/
typed
curl -X GET "https://seggwat.com/api/v1/projects/550e8400-e29b-41d4-a716-446655440000/ratings/stats/typed?type=helpful" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "type": "helpful",
  "total": 250,
  "helpful": 215,
  "not_helpful": 35,
  "percentage": 86.0
}

​
Overview

This endpoint returns aggregated statistics for a specific rating type. The response structure varies based on the rating type requested:
  • Helpful: Total, helpful count, not helpful count, percentage
  • Star: Total, average rating, distribution by star value
  • NPS: Total, NPS score, promoters/passives/detractors counts, distribution
For legacy helpful-only stats, you can also use the legacy endpoint.

​
Authentication

​
X-API-Key
string
required
Your Organization Access Token. See Authentication for details.

​
Path Parameters

​
project_id
string
required
The unique identifier of the project.

​
Query Parameters

​
type
string
default:"helpful"
Rating type to get statistics for. One of: helpful, star, nps.
​
path
string
Optional. Filter statistics to a specific page path.

​
Response

The response structure varies by rating type:
​
type
string
Always "helpful" for this response type.
​
total
integer
Total number of helpful ratings.
​
helpful
integer
Number of positive (helpful) ratings.
​
not_helpful
integer
Number of negative (not helpful) ratings.
​
percentage
number
Percentage of helpful ratings (0.0 - 100.0).

​
NPS Score Interpretation

Score RangeInterpretation
70+Excellent
50-69Great
30-49Good
0-29Needs improvement
NegativeCritical attention needed
curl -X GET "https://seggwat.com/api/v1/projects/550e8400-e29b-41d4-a716-446655440000/ratings/stats/typed?type=helpful" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "type": "helpful",
  "total": 250,
  "helpful": 215,
  "not_helpful": 35,
  "percentage": 86.0
}