Page Comparison

Getting the category list

Method Objective

The method allows getting information for all active NPS categories.

Syntax and parameters

Code Block

language	js
theme	FadeToGrey

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	Requirement	Description
segment_id	number/string	required	Segment ID. It's available in the PersonaClick account: CRM > Segments.
email	string	optionally	The current user's Email.
phone	string	optionally	The current user's Phone.

Examples of use

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", { "segment_id": 100500, "email": "john.doe@examplestore.com", "phone": "+10000000000" });

	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

language	js
theme	FadeToGrey

personaclick("segmentnps", "addcategories", function(categories) {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add",// NPS widget rendering
}, function(error) {
    "segment_id": 100500,
    "phone": "+10000000000"// when something went wrong
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", {"segment_id": 100500});

Removing from a segment

Getting the channel list

Method Objective

The method allows excluding the current user from a segmentgetting information for all active NPS channels.

Syntax and parameters

Code Block

language	js
theme	FadeToGrey

personaclick("segmentnps", "removechannels", paramssuccess, error);

Name	Type	Requirement	Description

params

success

Object

Function

required

Object with request parameters.

Request parameters

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	TypeRequirement	Description
segment_id	number/string	required	Segment ID. It's available in the PersonaClick account: CRM > Segments.
email	string	optionally	The current user's Email.
phone	string	optionally	The current user's Phone.

Examples

	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

language	js
theme	FadeToGrey

personaclick("segmentnps", "removechannels", {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com",
    "phone": "+10000000000"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "remove", function(channels) {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "remove",// using available NPS channels
}, function(error) {
    "segment_id": 100500,
    "phone": "+10000000000"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "remove", {"segment_id": 100500});

Getting the segment list

// when something went wrong
});

Saving the NPS 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

language	js
theme	FadeToGrey

personaclick("segmentnps", "get"review", params, success, callbackerror);

Name	Type	Requirement	Description

callback

params

Function

Object

required

Object with request parameters.

API response

TypeDescriptionObject array

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.


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.

Example of use

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "get", function(segments) {
    segments.forEach(function(segment"nps", "review", {
    channel: "website",
    category: "delivery",
    rate: 9,
    comment: "It's not bad, but it could be better."
}, function() {
    // when the  console.log(segment.id);
    survey is successfully saved
}, function(error) {
   console.log(segment.type);
    }); // when something went wrong
});

Column

Page Navigation

Table of Contents

maxLevel	2

classpersonaclick-fixed-position

indent	0px
style	none

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "nps"

Versions Compared

Old Version 3

New Version Current

Key

Getting the category list

Method Objective

Syntax and parameters

API response

Examples of use

Example of use

Removing from a segment

Getting the channel list

Method Objective

Syntax and parameters

API response

Example of use

Saving the NPS review

Method Objective

Syntax and parameters

API response

Request parameters

Example of use