Contendar Help

Scores by form

Get the NPS score for each form in a project. Use this to compare forms side by side.

GET /nps/scores-by-form

Authentication

Send your API key as a bearer token. See Authentication .

Query parameters

ParameterTypeRequiredNotes
projectIdUUIDyesThe project to read.
sincedatenoOnly count responses on or after this date. ISO date or date time.

Response

An array, one item per form.

[
  {
    "formBuilderId": "1f2e3d4c-5b6a-7980-1234-56789abcdef0",
    "formName": "Quarterly NPS survey",
    "npsScore": 42,
    "responseCount": 210,
    "scoredCount": 198
  },
  {
    "formBuilderId": "2a3b4c5d-6e7f-8091-2345-6789abcdef01",
    "formName": "Post onboarding check",
    "npsScore": 61,
    "responseCount": 88,
    "scoredCount": 85
  }
]

Response fields

FieldTypeNotes
formBuilderIdstringThe ID of the form.
formNamestringThe name of the form.
npsScorenumber or nullThe NPS score for this form, from -100 to 100. null when there are no scored responses.
responseCountnumberAll responses for this form.
scoredCountnumberResponses for this form that have a score.

Example

curl "https://app.contendar.com/api/v1/nps/scores-by-form?projectId=YOUR_PROJECT_ID" \
  -H "Authorization: Bearer ck_your_key_here"

Related pages

Was this helpful?