Net Promoter Score (JS SDK)

Getting the category list

Method Objective

The method allows getting information for all active NPS categories.

Syntax and parameters

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

Name	Type	Requirement	Description
success	Function	required	Object with request parameters.
error	Function	optionally

Request parameters

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

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

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

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

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

Removing from a segment

Method Objective

The method allows excluding the current user from a segment.

Syntax and parameters

personaclick("segment", "remove", params);

Name	Type	Requirement	Description
params	Object	required	Object with request parameters.

Request parameters

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

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

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

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

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

Getting the segment list

Method Objective

The method allows getting a list of segments that include the current user.

Syntax and parameters

personaclick("segment", "get", callback);

Name	Type	Requirement	Description
callback	Function	required	Object with request parameters.

API response

Type Description

Object 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.

Example of use

personaclick("segment", "get", function(segments) {
    segments.forEach(function(segment) {
        console.log(segment.id);
        console.log(segment.type);
    });
});