This function is designed to allow uploading of a single customer response record directly into CustomerGauge. You can post information like score, comment, self-select reasons, survey completed date and more along with your customer data.
Note:
Self-select reasons used in your survey are referred to as Reason Codes. Each self-select reason has a unique reason code. Please contact your client’s ops contact for the reason codes for your self-select reasons.
Resource Information
| Response formats | JSON (default), XML |
| HTTP Method | POST |
| Response family | transactions |
| Header | Authorization: api_key XXXXX |
Resource URL
POST Data
Post data as key value based on upload mapping.
POST Data Example Values
You can add data to the record you want to create using this API.
You can find some examples below;
| Key | Data |
| CustomerNumber | 1143 |
| lee_klameth@directness.net | |
| FirstName | Lee |
| LastName | Klameth |
There are many more fields, but field names are specific to your system — please contact your Customer Success Manager to know which fields are available to your system.
Survey result data
When you want to use this API, you probably want to insert survey results.
The fields below are available to you to add:
| NetPromoterScore | The score of the NPS question given – any number between 0 and 10. Example value: 10 |
| Comment | The open text comment box from your survey. Example value: I absolutely love your products! |
| EmailSentDate | The date & time of sending the survey invitation. The date format provided should be "YYYY-MM-DD HH:ii:ss" Example value: 2018-01-01 13:59:12 |
| SurveyCompletedDate | The date & time of completing the survey. The date format provided should be "YYYY-MM-DD HH:ii:ss" Example value: 2018-01-01 13:59:12 |
| FollowUpRequired | Whether or not the survey respondent wants you to contact them. Please provide "Y" if they want to be contacted, "N" if they don't want to be contacted. Example value: Y |
| WorkflowStatus | Workflow status Example Values: CLOSE Standard set: you can use OPEN, IN-PROGRESS, PROGRESS, CLOSED or CLOSE. Extended set: As an option CustomerGauge can enable an extended set of workflow status. In this case, you can set workflow status with integer values 0 – 99. We also provide a text look-up. Please ask for details. |
| ReasonCode | 10000,10020 |
Note:
Reason Code refers to the Self-select reasons used in your survey. Each self-select reason has its unique reason code. Please contact your Customer Success Manager for the reason codes of your self-select reasons.
Example Request
| cURL example | curl -X POST https://api.eu.customergauge.com/v4.1/transactions/response.json -d CustomerNumber=1143 -d Email=lee_klameth@directness.net -d FirstName=Lee -d LastName=Klameth -d ReasonCode=10000,10020 |
Example Result
Data contains number customergauge. Message reported on successful operation:
1 | {"Data":true} |
Message reported on failed operation:
1 | {"Error":{"Message":"Field email is required but seems to be empty.","Code":400003}} |