Using this API, you get Mailqueue record.


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 formatsJSON (default), XML
HTTP methodGET
Response familytransactions
Maximum records per API call1000
Default records per API call1000
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: 

https://api.eu.customergauge.com/v4.1/transactions/mailqueue.json


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

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/mailqueue.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.eu.customergauge.com/v4.1/transactions/mailqueue.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




{"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:





1




{"Error":{"Message":"Date method doesn’t support","Code":400001}}




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 CodeMapping
101Queue


Processed


Status CodeMapping
201Primary Sent
202Reminder Sent
203SMS Sent
204Opened
205Clicked
206Survey Finished (Deprecated)
207Survey Completed


Failed


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