Analytics
Get the NPS score and the promoter, passive, and detractor split for a project.
GET /nps/analyticsAuthentication
Send your API key as a bearer token. See Authentication .
Query parameters
| Parameter | Type | Required | Notes |
projectId | UUID | yes | The project to read. |
formBuilderId | UUID | no | Only count responses from this form. |
since | date | no | Only count responses on or after this date. ISO date or date time. |
Response
{
"total": 210,
"scoredTotal": 198,
"npsScore": 42,
"averageScore": 8.1,
"promoterCount": 120,
"passiveCount": 46,
"detractorCount": 32,
"distribution": [
{ "score": 0, "count": 2 },
{ "score": 9, "count": 70 },
{ "score": 10, "count": 50 }
]
}Response fields
| Field | Type | Notes |
total | number | All responses in scope. |
scoredTotal | number | Responses that have a score. |
npsScore | number or null | Promoter percent minus detractor percent, from -100 to 100. null when there are no scored responses. |
averageScore | number or null | The mean score. null when there are no scored responses. |
promoterCount | number | Responses with a score of 9 or 10. |
passiveCount | number | Responses with a score of 7 or 8. |
detractorCount | number | Responses with a score of 0 to 6. |
distribution | array | Count per score. Each item has a score from 0 to 10 and a count. |
Example
curl "https://app.contendar.com/api/v1/nps/analytics?projectId=YOUR_PROJECT_ID&since=2026-07-01" \
-H "Authorization: Bearer ck_your_key_here"Related pages
Was this helpful?