Introduction

This API is designed to allow uploading of a single customer response record directly into CustomerGauge. You can post information like score, comment, self-select reasons/drivers, survey completed date, and more, along with your customer data.


Good to know

API response format:

Our APIs return data in either JSON or XML format (depending on request by .json or .xml).


Required fields & field validations:

Based on your system's configuration, some fields may be required, or need to be in a specific format.

Contact your Customer Success Manager when in doubt.


Usually, the following validations apply:

  • Datetime is required and in YYYY-mm-dd H:i:s format.
  • Email is required for the upload to be valid


Interacting with drivers:

Self-select reasons/drivers used in your survey are referred to as Reason Codes. Each self-select reason has a unique reason code. Please contact your Customer Success Manager for the reason codes for your self-select reasons.


About this API

Resource Information

Response formats
JSON (default), XML
HTTP Method
POST
Response family
Transactions
Header    
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/transactions/response.json

US Production Server: https://api.us.customergauge.com/v4.1/transactions/response.json

Australia Production Server: https://api.au.customergauge.com/v4.1/transactions/response.json


How to call

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
Email
lee_klameth@directness.net
FirstName
Lee
LastName
Klameth


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


Example Request

To call the API through cURL:

curl -H "Authorization: api_key XXXXX" -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

Message reported on successful operation:

{
  "Data": true
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Field email is required but seems to be empty.",
    "Code": 400003
  }
}


 

Not the API you're looking for?

Related APIs:


APIs of the same family:


Similar API families:


Or view: