Table of Contents
Use this API to add Revenue to Accounts in your CustomerGauge platform, and benefit from the many insights CustomerGauge offers.
Closing the Loop
Warning: This API will not be supported in the near future. Implement this API at your own risk. An alternative will be made available shortly.
These API methods allow you to retrieve details of existing workflow statuses for, or update the new workflow status of, a survey record in your CustomerGauge system.
If you'd like to change the workflow status, or assign to someone:
Method type definition:
Get Method: Use this method to get (export) existing workflow statuses from the CustomerGauge system.
Post Method: Use this method to insert new workflow statuses to the CustomerGauge system.
Managing Unsubscribes & Bounces
These API methods allow you to add an e-mail address to unsubscribe, or retrieve a list of either bounced, or unsubscribed e-mail addresses.
Method type definition:
Get Method: Use this method to get (export) data from the CustomerGauge system.
Post Method: Use this method to upload (import) data to the CustomerGauge system.
Anonymizing Personal Data (GDPR)
To validate which records you're about to anonymize, use;
To anonymize those records, use:
Managing Hierarchy Levels
These API methods allow you to manage the hierarchy structure in your CustomerGauge system.
To retrieve your current hierarchy:
To add a new hierarchy level:
To update a hierarchy level:
To delete a hierarchy level:
Using 4.1 APIs
The APIs in our 4.1 API Suite can be outputted in XML or JSON.
What do you need to get started?
The recommended method of authentication is OAuth2. To authenticate through OAuth2, you'll need to use the Connected Apps (Setup → Integration → Connected Apps).
Unfortunately, some platforms do not support OAuth2 authentication to call (to them) external platforms. In those cases, you would need an API Key; you can find your API Key in the Admin section of your CustomerGauge system.
2. General API URL (based on your location):
3. Method type definition:
- Get Method: Use this method to get (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 data already existing in the CustomerGauge system
- Delete Method: Use this method to delete data from the CustomerGauge System
Authenticating with an API Key
We highly recommend you to authenticate using OAuth 2 authentication. However, some systems don't allow for that. To help you call our APIs anyway, you can call our APIs using an API Key to authenticate with.
You can find your API Key in Admin → API IP Whitelist. Once you have obtained it, you can use the API Key in the Request Headers to authenticate.
|Request Header||Header Value|
In curl, this would look something like this:
CustomerGauge API uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an error with CustomerGauge servers.
HTTP Status Code Summary
- 200 OK – Everything worked as expected.
- 400 Bad Request – Often missing a required parameter.
- 401 Unauthorized – No valid API key provided.
- 500, 502, 503, 504 Server errors – something went wrong on CustomerGauge end.
Example of Error Message
|200000||API Authentication||Invalid API key||401|
|300000||General||Too many params supplied||400|
|300001||General||Invalid arguments supplied||400|
|300002||General||Module does not exist||404|
|300003||General||Method does not exist||405|
|300004||General||Required field does not supplied||400|
|400000||Modules||Transactions||Filter key doesn’t exist||400|
|400001||Modules||Transactions||Date method doesn’t support||400|
|400002||Modules||Transactions||Record does not exist||400|
|400003||Modules||Transactions||Failed to insert record||400|
|400004 ||Modules||Transactions||Wrong id provided||400|
|400005 ||Modules||Transactions||id not found||400|
|400006||Modules||Transactions||No mapping found for date form completed||400|
|400007||Modules||Transactions||Date form completed value should be supplied for response upload||400 |
|400008||Modules||Transactions ||Date form completed value should not be supplied for non response upload||400 |
|400009||Modules||Transactions||Days can’t be more than 365||400|
|400010||Modules||Transactions||Field id is required but seems to be empty||400|
|400011||Modules||Transactions||Workflow status does not exist||400|
|400100||Modules||File||Could not find requested file.||400|
|400101||Modules||File||S3 location can not be empty.||400|
|400102||Modules||File||Could not load field configurations.||400|
|400103||Modules||File||Upload has already been processed.||400|
|400104||Modules||File||File type could not be determined.||400|
|400105||Modules||File||File could not be found.||400|
|400106||Modules||File||File is not of valid file type.||400|
|400107||Modules||File||Could not parse XML correctly.||400|
|400108||Modules||File||Duplication Rule is not of an expected format.||400|
|400109||Modules||File||Could not retrieve Duplication Rule.||400|
|400110||Modules||File||Could not find posted temp file.||400|
|400111||Modules||File||File name of posted file is not valid.||400|
|400112||Modules||File||Could not find requested file.||400|
|400113||Modules||File||File name of requested file is not valid.||400|
|400115||Modules||File||File data can not be empty.||400|
|400116||Modules||File||Failed loading XML.||400|
|400120||Modules||File||Could not make connection to database.||400|
|400121||Modules||File||Duplication Rule is not of an expected format.||400|
|400122||Modules||File||Query could not be executed correctly.||400|
|400123||Modules||File||Something went wrong while detecting duplication.||400|
|400124||Modules||File||Could not parse duplication rule correctly.||400|
|400140||Modules||File||Method of uploading unclear; should be POST params s3 or http or upload by POST.||400|
|400141||Modules||File||Failed to retrieve list of Transactional uploads||400|
|400142||Modules||File||ID required, but missing||400|
|400143||Modules||File||ID can not be empty||400|
|400160||Modules||File||Method of uploading unclear; should be POST params s3 or http or upload by POST.||400|
|400161||Modules||File||Failed to retrieve list of Contact uploads||400|
|400162||Modules||File||ID required, but missing||400|
|400180||Modules||File||Method of uploading unclear; should be POST params s3 or http or upload by POST.||400|
|400181||Modules||File||Failed to retrieve list of Historical uploads||400|
|400182||Modules||File||ID required, but missing||400|
|400183||Modules||File||ID can not be empty||400|
|400184||Modules||File||No data found with passed parameters||400|
|400201||Modules||Workflow||Required field ‘number_customergauge’ not supplied||400|
|400300||Modules||Products||Couldn’t get data from given url||400|
|400301||Modules||Products||No data provided||400|
|400302||Modules||Products||Field doesn’t exist||400|
|400303||Modules||Products||No mapping field found for product API output||400|
|400400||Modules||Lists||No mapping field found for unsubscribe API output||400|
|400402||Modules||Lists||Email address is required||400|
|400403||Modules||Lists||Email address already exist in the unsubscribe list||400 |
|400404||Modules||Lists||No mapping field found for bounce API output||400 |
|400500||Modules||Company Summary||No mapping field found for company_summary API output||400 |
|400501||Modules||Company Summary||Date method doesn’t support||400|
|400601||Modules||Reasons ||Required field ‘reason_code’ not supplied||400 |
|400602||Modules ||Reasons ||Reason code already exist||400 |
|400603||Modules||Reasons ||Reason code does not exist||400 |
|400604||Modules ||Reasons ||Record not inserted. Something went wrong. Please check your data.||400 |
|400605||Modules||Reasons ||Record not updated. Something went wrong. Please check your data.||400 |
|400606||Modules||Reasons||Level 2 can’t save without having Level 1||400|
|400607||Modules||Reasons||Required field ‘good_bad’ not supplied||400|
|400608||Modules||Reasons||Wrong data provided on ‘good_bad’ field||400|
|400700||Modules||Stream||No data provided||400|
|400800||Modules||Anonymize||Required field ‘id’ not supplied||400|
|400900||Modules||Hierarchy||Parent doesn’t exist||400|
|400901||Modules||Hierarchy||Division doesn’t exist||400|
|400902||Modules||Hierarchy||Global division can not be updated||400|
|400903||Modules||Hierarchy||Global division can not be deleted||400|
|400904||Modules||Hierarchy||Parent division can not be deleted||400|