Table of Contents

• Revenue
• Closing the Loop
• Managing Unsubscribes & Bounces
• Anonymizing Personal Data
• Managing Hierarchy Levels
• Using 4.1 APIs
• Authenticating with an API Key
• Error Codes

Revenue

Use this API to add Revenue to Accounts in your CustomerGauge platform, and benefit from the many insights CustomerGauge offers.

File

• Revenue (GET/POST)

Closing the Loop

Workflow

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.

Introduction

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.

API Methods

If you'd like to change the workflow status, or assign to someone:

• POST Workflow

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

Introduction

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.

 Unsubscribes

• GET Unsubscribe
• POST Unsubscribe

Bounces

• GET Bounce

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;

• GET Anonymize

To anonymize those records, use:

• POST Anonymize

Managing Hierarchy Levels

Introduction 

These API methods allow you to manage the hierarchy structure in your CustomerGauge system.

To retrieve your current hierarchy:

• GET Hierarchy

To add a new hierarchy level:

• POST Hierarchy

To update a hierarchy level:

• PUT Hierarchy

To delete a hierarchy level:

• DELETE Hierarchy

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?

1. Authentication

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):

• EU server: https://api.eu.customergauge.com
• US server: https://api.us.customergauge.com
• AU server: https://api.au.customergauge.com

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.

In curl, this would look something like this:

curl -H "Authorization: api_key XXXXX" -X GET "https://api.eu.customergauge.com/v4.1/ApiFamily/ApiMethod.json"

{"Error":{"Message":"Invalid API Key","Code":2000}}

<Error><Message>Invalid API Key</Message><Code>2000</Code></Error>