Introduction
Use this API to get one or more records that can be found through the GET Response or GET Non-Response APIs.
Good to know
Data limit:
We return up to 1,000 records per call. To get more than 1000 records, use the "start" parameter (e.g., &start=1000).
API response format:
Our APIs return data in either JSON or XML format (depending on request by .json or .xml).
Returned data:
We normally provide a standard range of fields in the API output.
If you need to change the fields, order, or field names, please contact your Customer Success Manager.
About this API
Resource Information
| Response formats | JSON (default), XML |
| HTTP method | GET |
| Response family | Transactions |
| Maximum records per API call | 1000 |
| Default records per API call | 1000 |
| Header | Authorization: api_key XXXXX |
Resource URL
Europe Production Server: https://api.eu.customergauge.com/v4.1/transactions.json
US Production Server: https://api.us.customergauge.com/v4.1/transactions.json
Australia Production Server: https://api.au.customergauge.com/v4.1/transactions.json
How to call
Parameters
| filter_FIELDNAME optional | Filter API data based on specific field Example Filter Parameter: filter_division |
| days optional | Filter the data from last specific days Example Values: 10 |
| date_range_from optional | Filter the data from date Example Values: 2012-09-01 |
| date_range_to optional | Filter the data to date Example Values: 2012-10-01 |
| date_method optional | default: date_order Possible Values: date_order |
| start optional | default: 0 Example Values: 10 |
| limit optional | default: 1000 Example Values: 200. Maximum is 1000 |
| status optional | Filter data by status Example Values: BOUNCED, ERROR, PROCESSED, QUEUE, UNSUBSCRIBED |
Example Requests
To call the API through cURL:
curl -H "Authorization: api_key XXXXX" -X GET "https://api.eu.customergauge.com/v4.1/transactions.json?filter_division=Staff&date_range_from=2011-05-31 00:00:00&date_range_to=2011-06-01%2000:00:00"
Browser examples:
Example: Get the records where the field “division” is equal to the value “Staff” and the Order Date is between 31 May 2011 (2011-05-31 00:00:00) and 1 June 2011 (2011-06-01 00:00:00).
| GET (json) | https://api.eu.customergauge.com/v4.1/transactions.json?filter_division=Staff&date_range_from=2011-05-31%2000:00:00&date_range_to=2011-06-01%2000:00:00 |
| GET (xml) | https://api.eu.customergauge.com/v4.1/transactions.xml |
Example Result
Message reported on successful operation:
{
"Data": [{
"NPS": "NA",
"First_Name": "Enrico",
"CG_ID": "42000208",
"Date_Order": "2011-05-31 00:00:00"
},
{
"NPS": "NA",
"First_Name": "Petra",
"CG_ID": "42000228",
"Date_Order": "2011-05-31 00:00:00"
},
{
"NPS": "NA",
"First_Name": "Kurt",
"CG_ID": "42000209",
"Date_Order": "2011-06-01 00:00:00"
}
],
"Total_Records": 3
}Message reported on failed operation:
{
"Error": {
"Message": "Date method doesn’t support",
"Code": 400001
}
}Additional Information
Status Codes Mapping
If you wish to receive the status code as part of your response, please let your client operations manager know.
Queue
| Status Code | Mapping |
| 101 | Queued to be processed for sending |
Processed
| Status Code | Mapping |
| 201 | Primary Sent |
| 202 | Reminder Sent |
| 203 | SMS Sent |
| 204 | Opened |
| 205 | Clicked |
| 206 | Survey Finished (Deprecated) |
| 207 | Survey Completed |
Failed
| Status Code | Mapping |
| 301 | Error General |
| 302 | Error Data |
| 303 | Error Template |
| 304 | Bounce |
| 305 | Spam |
| 306 | Unsubscribe |
| 307 | Duplicated |
Not the API you're looking for?
Related APIs:
APIs of the same family:
Similar API families:
Or view: