This API allows you to get NPS summary.


Resource Information

Response formats
JSON (default), XML
HTTP method
GET
Response family
report
Header
Authorization: api_key XXXXX



Resource URL

Production Server:

https://api.customergauge.com/v4.1/report/nps.json


Parameters


filter_FIELDNAME
optional

Filter api data based on specific field
Example Filter Parameter: filter_Country
date_method
optional
default: date_order
Possible Values: date_order, date_form_completed, date_email_sent
period
optional
default: LAST_30_DAYS
Possible Values: YESTERDAY, TODAY, LAST_WEEK, THIS_WEEK, LAST_MONTH, THIS_MONTH, LAST_30_DAYS, LAST_90_DAYS, THIS_QUARTER, LAST_QUARTER
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



Example Requests


GET (json)
https://api.customergauge.com/v4.1/report/nps.json?filter_Country=Netherlands&period=LAST_MONTH


GET (xml)
https://api.customergauge.com/v4.1/report/nps.xml?filter_Country=Netherlands&period=LAST_MONTH


Example Result

Message reported on successful operation:



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16




{
   "Data":{
         "nps":14,
         "responses":14,
         "comments":"7",
         "comment_percent":50,
         "detractors":"4",
         "passives":"4",
         "promoters":"6",
         "detractors_percent":29,
         "passives_percent":29,
         "promoters_percent":43,
         "date_from":"2015-07-01",
         "date_to":"2015-09-30"
   }
}