Versions Compared
compared with
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 | ||||
|---|---|---|---|---|
| ||||
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. |
API 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. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
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 | ||||
|---|---|---|---|---|
| ||||
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. |
API 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. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("nps", "channels", function(channels) {
// using available NPS channels
}, function(error) {
// when something went wrong
}); |
Saving the
segment listNPS review
Method Objective
The method allows getting a list of segments that include the current usersaving the results of the NPS survey.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segmentnps", "getreview", success, callbackerror); |
| Name | Type | Requirement | Description |
|---|
| success | Function | required |
API response
Object array, each will have the following properties:
- id (number) - the Segment ID.
- type (string) - the Segment Type. It can have the following values:
static, dynamic.
| 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. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segmentnps", "getreview", function(segments) {
segments.forEach(function(segment) {
console.log(segment.id);
// when the survey is successfully saved
}, function(error) {
// when console.log(segment.type);
});something went wrong
});
|
| Table of Contents | ||||
|---|---|---|---|---|
|