Introduction

This API is designed to allow upload of an account-based revenue file directly into CustomerGauge.


Good to know

Maximum file size:

Please do not upload files larger than 2MB.


Maximum number of records:

Please do not upload files with more than 1,000 records.


Uploadable file types:

We accept CSV, XLS(X), and XML files (note: no JSON files).


API response format:

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


Order of fields:

Data should provided in the following order (even for XML!):

  • Account name
  • Revenue amount
  • Revenue start date
  • Revenue end date
  • Revenue type
  • Description


Revenue number formatting:

When providing revenue, please don't use thousands separators, and no decimals.

For example, a revenue value of 1,234.12 must be provided as 1234.


Case-insensitive:

Data provided is case-insensitive — the value uploaded for the first time will be displayed.


About this API

Resource information

Response formatsJSON (default), XML
HTTP MethodPOST
Response familyFile
HeaderAuthorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/company/revenue_file_automate.json

US Production Server: https://api.us.customergauge.com/v4.1/company/revenue_file_automate.json

Australia Production Server: https://api.au.customergauge.com/v4.1/company/revenue_file_automate.json


How to call

Parameters

KeyDataDescription
fileDocuments/file_name.csvAutomatically provided when POST-ing a file through HTTP protocol.


Upload File Example Request

Post your file by calling our API as if posted from a form.


curl -H "Authorization: api_key XXXXX" -F "file=@LOCAL_LOCATION/file_name.csv" "https://api.eu.customergauge.com/v4.1/company/revenue_file_automate.json"


Example Result

Data states if successful or not. Message reported on successful operation:

{
    "Data": {
        "data": 1
    }
}


Message reported on failed operation:

{
    "Data": false
}


Sample files

At the bottom of this document you can find some sample files with the correct format and order.


Not the API you're looking for?

View: