TABLE OF CONTENTS



 

API Setup

Choose your Host Region to have the documentation adapt to your use case.


Host Region
LabelValue
EUeu
USus
AUau






Business Use Case

You can use this API to create or update a single Revenue item in CustomerGauge. By supplying your Revenue for your Accounts, you can leverage all the Monetize 5.0 Reporting.






Good to Know

Changes to Import Configurations

If a change happens to the implementation of the API (for example a field name change), that should be reflected in the used Inbound Mapping as well. Ignoring to do so will cause the API to silently fail for the fields involved.


Required Fields

The following fields are required in your Inbound Mapping:


Data TypeRequired FieldsNotes
Revenue
  • Account Name
  • Year
  • Value
Year must be a whole number.
Value must be a whole number.







Authentication

OAuth2 Authentication is used to connect to this API. Once you've created your Connected App, you can acquire a Bearer Access Token by calling our OAuth2/Token API:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=client_credentials&client_id={{ Client ID }}&client_secret={{ Client Secret }}"
https://auth.{{ apiRegion }}.customergauge.com/oauth2/token

The acquired Bearer Access Token is used in the Authorization header in your API request.






Endpoint

Endpoint URL
https://imports.api.{{ apiRegion }}.customergauge.com/records/






Request


Parameters

Use these parameters in the API request to pass the relevant information to the API.


ParameterDescriptionRulesExamples
configuration

Configuration reference for data type and mapping.


You can find it in Data → Rest APIs → Inbound Mapping, under the Reference column.

  • Required
Example value
9dd58237-c913-4073-9c76-07da0b49ff50
record[]
An array for all the fields to be imported.

The values in the array must be the same set up in the API mapping referenced in the configuration parameter.

  • Required
Example parameters
record[Account Name]
record[Year]
record[Value]



Supported Formats


JSON (raw request body)

Data can be passed to this API using the JSON format in the body of the request.


Example parameters:

{
    "configuration": "53505294-0b20-2509-b15d-c8e377701d66",
    "record": {
        "Account Name": "ACME",
        "Year": "2024",
        "Value": "250999",
     }
}


x-www-form-urlencoded (body)

Data can be passed to this API using the x-www-form-urlencoded format in the body of the request.


Example parameters:

configuration: "12305294-0b20-4009-b95d-c8123301d66"
record[Account Name]: "ACME"
record[Year]: "2024"
record[Value]: "250999"




Response

HTTP Status CodeDescription
200OK - everything worked as expected.

Example Response Body
An empty Response Body will be returned when successful.
422An issue occurred - this usually means one of the required fields is missing.

Example Response Body
{
    "message": "The given data was invalid.",
    "errors": {
        "configuration": [
            "The configuration field is required."
        ]
    }
}






Not the API you're looking for?

Get an overview of our APIs here.