Introduction

This API is ideal for uploading the number of Receipt Transactions, Login Sessions, or Support Ticket in the case of an anonymous survey. 

Depending on the requirement, the transaction record can be broken down into granular details. For example, number of daily/weekly/monthly support tickets for transactional/relationship touchpoint.


You would typically use this API to be able to report on your Response Rate, if you're running anonymous surveys.

If you'd just like to upload historical survey data, you can do so through the POST Historical API.


This API is designed to allow upload of a single data 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 2,000 records.


Upload interval / frequency:

Multiple upload calls made in quick succession will get queued, and periodically retried, but to obtain optimum performance we recommend allowing the previous upload to finish before attempting the next one. (Uploads can take anywhere between a few seconds and several minutes depending on the size and complexity of data.)


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


Field validation:

Dates should be provided in YYYY-mm-dd H : i : s format (2018-12-23 13:49:56).


About this API

Resource Information

Response formats
JSON (default), XML
HTTP Method
POST
Response family
File
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/file/transactions_activity.json

US Production Server: https://api.us.customergauge.com/v4.1/file/transactions_activity.json

Australia Production Server: https://api.au.customergauge.com/v4.1/file/transactions_activity.json


How to call

Parameters

Key
Data
Description
file
Documents/file_name.xml
Automatically provided when POST-ing a file through HTTP protocol.

Upload File Example Request

To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -F “file=@LOCAL_LOCATION/file_name.xml” “https://api.customergauge.com/v4.1/file/transactions_activity.json"


Example Result

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

{
  "Data": {
    "id": "1"
  }
}


Message reported on failed operation:

{
  "Error": {
    "Message": "This upload has already been processed",
    "Code": 400103
  }
}



Not the API you're looking for?

APIs of the same family:


Or view: