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.
Request
| Endpoint | Request Type |
|---|---|
| https://api.personaclick.com/nps/categories | GET |
Parameters
Any of the parameters below can be used to obtain profile properties:
| Name | Type | Requirement | Description |
|---|---|---|---|
| shop_id | string | required | Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | See the "message" property of the API response for details. |
| 403 Forbidden | See the "message" property of the API response for details. |
| 403 Forbidden | Failed authorization. |
| 404 Not Found | Shop Not Found. |
API Response
The API returns an array of category objects. Below are the properties of a single object.
| 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 });curl 'https://api.personaclick.com/nps/categories?shop_id=0d42fd8b713d0752776ca589cc0056' |
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 NPS review
Method Objective
The method allows saving the results of the NPS survey.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("nps", "review", params, success, error); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | Object | required | Object with request parameters. |
| 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. |
Request parameters
Name | Type | Requirement | Description |
|---|---|---|---|
channel | string | required | The NPS channel code. |
| category | string | required | The NPS category code. |
| rate | number | required | The rating got from the user. |
| comment | string | optionally | User comment. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("nps", "review", {
channel: "website",
category: "delivery",
rate: 9,
comment: "It's not bad, but it could be better."
}, function() {
// when the survey is successfully saved
}, function(error) {
// when something went wrong
});
|
Reading the NPS review
| Table of Contents | ||||
|---|---|---|---|---|
|