You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
Getting the category list
Method Objective
The method allows getting information for all active NPS categories.
Syntax and parameters
Name
Type
Requirement
Description
success
Function
required
The callback function that takes the API response. The API response type is an Object array.
error
optionally
The callback function in case of an error - any non 200 HTTP response.
API response
id
number
NPS Category ID.
code
string
The unique code of the NPS category.
name
The name of the NPS category.
promoter_question
The question is for the "Promoter" user type.
promoter_success
Thanks-message for the "Promoter" user type.
passive_question
The question is for the "Passive" user type.
passive_success
Thanks-message for the "Passive" user type.
detractor_question
The question is for the "Detractor" user type.
detractor_success
Thanks-message for the "Detractor" user type.
Example of use
Getting the channel list
The method allows getting information for all active NPS channels.
NPS Channel ID.
The unique code of the NPS channel.
The name of the NPS channel.
Creating the NPS review
The method allows saving the results of the NPS survey.
The callback function will be executed if the request is successful.