Net Promoter Score (JS SDK)

Getting the category list

The method allows getting information for all active NPS categories.

personaclick("nps", "categories", success, error);

Name	Type	Requirement	Description
success	Function	required	The callback function that takes the API response. The API response type is an Object array.
error	Function	optionally	The callback function in case of an error - any non 200 HTTP response.

Name	Type	Description
id	number	NPS Category ID.
code	string	The unique code of the NPS category.
name	string	The name of the NPS category.
promoter_question	string	The question is for the "Promoter" user type.
promoter_success	string	Thanks-message for the "Promoter" user type.
passive_question	string	The question is for the "Passive" user type.
passive_success	string	Thanks-message for the "Passive" user type.
detractor_question	string	The question is for the "Detractor" user type.
detractor_success	string	Thanks-message for the "Detractor" user type.

personaclick("nps", "categories", function(categories) {
    // NPS widget rendering
}, function(error) {
    // when something went wrong
});

The method allows getting information for all active NPS channels.

personaclick("nps", "channels", success, error);

Name	Type	Requirement	Description
success	Function	required	The callback function that takes the API response. The API response type is an Object array.
error	Function	optionally	The callback function in case of an error - any non 200 HTTP response.

Name	Type	Description
id	number	NPS Channel ID.
code	string	The unique code of the NPS channel.
name	string	The name of the NPS channel.

personaclick("nps", "channels", function(channels) {
    // using available NPS channels
}, function(error) {
    // when something went wrong
});

The method allows saving the results of the NPS survey.

personaclick("nps", "review", success, error);

Name	Type	Requirement	Description
success	Function	required	The callback function will be executed if the request is successful.
error	Function	optionally	The callback function in case of an error - any non 200 HTTP response.

personaclick("nps", "review", function() {
    // when the survey is successfully saved
}, function(error) {
    // when something went wrong
});