Returns customer response details – by this we mean “completed” records that contain a valid customer entry like NPS or comment.


You are limited to a response of 1000 records in a single API call (the default is 1000). To get more than 1000 records, use the Start Parameter (eg, Limit 1000, Start = 1000).


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

Production Server:

https://api.customergauge.com/v4.1/transactions/response.json


Parameters

filter_FIELDNAME
optional
Filter api data based on specific field
Example Filter Parameter: filter_cgid, 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”, “date_email_sent”, “date_email_click”, “date_form_completed”
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
workflow
optional
Filter data by workflow
Example Values: OPEN, PROGRESS, CLOSE


Example Requests


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.customergauge.com/v4.1/transactions/response.json?filter_division=Staff&date_range_from=2011-05-31 00:00:00&date_range_to=2011-06-01 00:00:00


GET (xml) https://api.customergauge.com/v4.1/transactions/response.xml



Example Result


Message reported on successful operation:




1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26




{"Data":
      [
       {
         "NPS":"9",
         "First_Name":"Enrico",
         "CG_ID":"42000208",
         "Date_Order":"2011-05-31 00:00:00",
         "Comment":""
       },
       {
          "NPS":"2",
          "First_Name":"Petra",
          "CG_ID":"42000228",
          "Date_Order":"2011-05-31 00:00:00",
          "Comment":"I was a little disappointed with the web site offering compared to the store"
       },
       {
          "NPS":"10",
          "First_Name":"Kurt",
          "CG_ID":"42000209",
          "Date_Order":"2011-06-01 00:00:00",
          "Comment":""
       }
      ],
  "Total_Records":3
   }




Message reported on failed operation:




1




{"Error":{"Message":"Record does not exist","Code":400002}}




We normally provide a standard range of fields in the API output. If you need to change the fields displayed, or the order, or the names, please contact the client ops team, who can make a small adjustment. 

 

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 Queue


Processed

Status Code Mapping
201 Primary Sent
202 Reminder Sent
203 SMS Sent
204 Opened
205 Clicked
206 Survey Finished
207 Survey Completed


Failed

Status Code Mapping
301 Error General
302 Error Data
303 Error Template
304 Bounce
305 Spam
306 Unsubscribe
307 Duplicated