Introduction

These API methods allow you to manage (insert, update, or delete) a single customer record or retrieve a list of multiple customer records from your CustomerGauge system.


You can either use one of the specific API’s below or use the general routing API, which will detect the destination, based on certain fields included in the data.


Good to know

API response format:

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


Method type definition:

Get Method: Use this method to get a list of records (export) data from the CustomerGauge system.


Post Method: Use this method to upload (import) data to the CustomerGauge system.


Put Method: Use this method to update a single record from the CustomerGauge system.


Delete Method: Use this method to permanently delete a record from the CustomerGauge system (not to be confused with Anonymizing a record).


When to call which API

Mail queue:

Use this API set to interact with survey records that need to be delivered – similar to doing a Transactional Upload in the In-App Upload.

If you're looking to create new survey records that need to be delivered, the POST mailqueue is the API you're looking for.


To see a list of records:


To insert a single survey record to be processed and delivered:


To update a single survey record to be processed and delivered:


To delete a single survey record:


Non Responses:

Use this API set to interact with survey records where the survey did not get completed.


To see a list of records:


To insert a single survey record that didn't get completed yet:


To update a single survey record that didn't get completed yet:


To delete a single survey record:


Responses:

Use this API set to interact with survey records that have been completed.


To see a list of records:


To insert a single completed survey record:


To update a single completed survey record:


To delete a single survey record:


General:

Use this API set to interact with survey records if you don't know if they're in "Mail queue", "Non Responses" or "Responses".


To see a list of records:


To update a single survey record:


To delete a single survey record: