Versions Compared

Old Version 1

changes.mady.by.user Andrey Veprikov

Saved on

compared with

New Version 2

changes.mady.by.user Andrey Veprikov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Getting the category list

Method Objective

The method allows getting information for all active NPS categories.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("nps", "categories", success, error);
NameTypeRequirementDescriptionsuccessFunctionrequiredThe callback function that takes the API response. The API response type is an Object array.errorFunctionoptionallyThe callback function in case of an error - any non 200 HTTP response.

API response

NameTypeDescriptionidnumberNPS Category ID. codestringThe unique code of the NPS category.namestring

The name of the NPS category.

promoter_questionstringThe question is for the "Promoter" user type.promoter_successstringThanks-message for the "Promoter" user type.passive_questionstringThe question is for the "Passive" user type.passive_successstringThanks-message for the "Passive" user type.detractor_questionstringThe question is for the "Detractor" user type.detractor_successstringThanks-message for the "Detractor" user type.

Example of use

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

Getting the channel list

Method Objective

The method allows getting information for all active NPS channels.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("nps", "channels", success, error);
NameTypeRequirementDescriptionsuccessFunctionrequiredThe callback function that takes the API response. The API response type is an Object array.errorFunctionoptionallyThe callback function in case of an error - any non 200 HTTP response.

API response

NameTypeDescriptionidnumberNPS Channel ID. codestringThe unique code of the NPS channel.namestring

The name of the NPS channel.

Example of use

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

Saving the NPS review

Method Objective

The method allows saving the results of the NPS survey.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("nps", "review", params, success, error);sdk.review(params) { callback }

The callback function in case of an error - any non 200 HTTP response
NameTypeRequirementDescription
paramsObjectparamsrequiredObject with request Request parameters.
successcallbackFunctionrequiredThe callback function will be executed if the request is successful.errorFunctionoptionally.

Request parameters

Name

TypeRequirement

Description

channel

stringrequired

The NPS channel code.

categorystringrequiredThe NPS category code.
ratenumberrequiredThe rating got from the user.
commentstringoptionallyUser comment.
order_idstringoptionallyOrder ID, related to the current survey

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("nps", "review", {
    sdk.review(rate: 9, channel: "websiteios_app",
    category: "delivery",     rateorder_id: 9,
    "ORDER-100500", comment: "It's not bad, but it could be better.") }, function() {{ _ in
    // when the survey is successfully saved
}, function(error) {
   
// when something went wrong
});


Table of Contents
maxLevel2
classpersonaclick-fixed-position