Introduction
This API is designed to return your drivers (formerly known as Self-Select Reasons).
Good to know
API response format:
Our APIs return data in either JSON or XML format (depending on request by .json or .xml).
About this API
Resource Information
Response formats | JSON (default), XML |
HTTP method | GET |
Response family | Reasons |
Header | Authorization: api_key XXXXX |
Resource URL
Europe Production Server: https://api.eu.customergauge.com/v4.1/reasons.json
US Production Server: https://api.us.customergauge.com/v4.1/reasons.json
Australia Production Server: https://api.au.customergauge.com/v4.1/reasons.json
How to call
Parameters
show_for optional | Promoter or Detractor&Neutral Example Values: Promoter |
Example Requests
GET (json) | https://api.eu.customergauge.com/v4.1/reasons.json&show_for=Promoter |
GET (xml) | https://api.eu.customergauge.com/v4.1/reasons.xml&show_for=Promoter |
To call this API through cURL:
curl -H "Authorization: api_key XXXXX" -X GET "https://api.eu.customergauge.com/v4.1/reasons.json"
Example Result
Message reported on successful operation:
{ "Data": [{ "reason_code": "11060", "numeration": "1.6", "position": "6", "show_for": "Detractor&Neutral", "good_bad": "neg", "category_main": "Customer Support", "level": "2", "label": "Other (Please tell us more in the box below)" }, { "reason_code": "1144", "numeration": "0", "position": "1", "show_for": "Detractor&Neutral", "good_bad": "neg", "category_main": "", "level": "0", "label": "" } ] }
Understanding the output:
- Reason Code – Each self-select reason has its unique reason code.
- Position refers to the position/order that particular self-select reason appears at with respect to all the self-select options.
- good_bad refers to if a particular reason is shown for promoter or detractor. Options that will be returned are pos for promoter and neg for detractor and passive.
- category_main is the category under which this level falls under.
- level – refers to whether this issue is a level 1 or 2. The options that will be returned are 1 for Level 1 Self-Select Issue and 2 for Level 2 Self-Select Issue.
- label – Refers to the label name shown on the survey for the self-select reasons.
Message reported on failed operation:
{ "Error": { "Message": "Required field 'reason_code' not supplied", "Code": 400601 } }
Not the API you're looking for?
Related APIs:
Or view: