Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Getting the category list

Method Objective

The method allows getting information for all active NPS categories.

Request

EndpointRequest Type
https://api.personaclick.com/nps/categoriesGET

Parameters

Any of the parameters below can be used to obtain profile properties:

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings

API Response Code

HTTP status code

Description
200 OK

The request was successful.

403 ForbiddenFailed authorization.
404 Not FoundShop Not Found.

API Response

The API returns an array of category objects. Below are the properties of a single object.

NameTypeDescription
idnumberNPS 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

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.

Request

EndpointRequest Type
https://api.personaclick.com/nps/channelsGET

Parameters

Any of the parameters below can be used to obtain profile properties:

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings

API Response Code

HTTP status code

Description
200 OK

The request was successful.

403 ForbiddenFailed authorization.
404 Not FoundShop Not Found.

API Response

The API returns an array of channel objects. Below are the properties of a single object.

NameTypeDescription
idnumberNPS Channel ID. 
codestringThe unique code of the NPS channel.
namestring

The name of the NPS channel.

Example of use

curl 'https://api.personaclick.com/nps/channels?shop_id=0d42fd8b713d0752776ca589cc0056'

Saving the NPS review

Method Objective

The method allows saving the results of the NPS survey.

Request

EndpointRequest TypeContent-Type
https://api.personaclick.com/nps/createPOSTapplication/x-www-form-urlencoded

Parameters

Name

TypeRequirement

Description

shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secretstringrequired if "did" property doesn't useStore Secret Key in PersonaClick. Located there: Account > Settings > Store Settings
didstringrequired if "shop_secret" property doesn't useUnique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
seancestringrequiredUnique ID of the current user session. See "Initialization (REST API)" for information about getting and using User Session ID.
emailstringrequired if "did" property doesn't useUser's email
phonestringrequired if "did" property doesn't useUser's phone
loyalty_idstringoptionallyUser's Loyalty ID
order_idstringoptionallyOrder ID, related to the current survey

channel

stringrequired

The NPS channel code.

categorystringrequiredThe NPS category code.
ratenumberrequiredThe rating got from the user.
commentstringoptionallyUser comment.

API Response Code

HTTP status code

Description
200 OK

The request was successful.

400 Bad RequestSee the "message" property of the API response for details.
403 ForbiddenSee the "message" property of the API response for details.
404 Not FoundRequired query parameters are missed or undefined.

API Response Data

The response is JSON type with the following properties:

NameTypeDescription
statusstring

Current status. Can have one of two values:

  • success - the request was successful
  • error - the request was unsuccessful
messagestring

The text of the error if it occurred

Examples of use

# by using shop secret and user's email
curl 'https://api.personaclick.com/nps/create' \
  -X 'POST' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&category=category_id&channel=channel_id&rate=8&comment=ok%20thanks&email=john.doe%40examplemail.com'

# by using DID
curl 'https://api.personaclick.com/nps/create' \
  -X 'POST' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'shop_id=0d42fd8b713d0752776ca589cc0056&did=7rjVGhMykT&category=category_id&channel=channel_id&rate=8&comment=ok%20thanks'

Reading the NPS review


  • No labels

Copyright 2018-2024 PersonaClick