This request will retrieve summarised results of feedback.
The following fields are included in the response:
|
Key |
Value Example |
Format |
|
name |
Springfield |
AlphaNumeric |
|
promoters |
2 |
Numeric |
|
promotersPercent |
50 |
Numeric |
|
passive |
1 |
Numeric |
|
passivePercent |
25 |
Numeric |
|
detractors |
1 |
Numeric |
|
detractorsPercent |
25 |
Numeric |
|
totalResponses |
4 |
Numeric |
|
nps |
25 |
Numeric |
2.2.1 Request
Method: GET
URL: api.feedback.fyi/feedback/summary/[clientDisplayId]?fromDate=[fromDate]&toDate=[toDate]&aggregate=[aggregate]
Path Parameters: clientDisplayId
Important: The clientDisplayId is specified in the URL path. Specifying the clientDisplayId as a parameter after the URL will result in a failure.
Parameters:
|
Key |
Value Example |
Format |
Req* |
Details |
|
fromDate |
1517270400 |
Timestamp |
||
|
toDate |
1517443200 |
Timestamp |
||
|
aggregate |
POM, or Location, or Client |
Alpha |
Yes |
POM will provide results grouped by POMs as well as the total across the Client. Location will provide results grouped by Locations as well as the total across the Client. Client will provide results grouped by Client as well as the total across the Client. |
Example Request with Parameters:
https://api.feedback.fyi/feedback/summary/92334d326e34432d43354365c7d2279a?fromDate=1517270400&toDate=1517443200&aggregate=pom
2.2.2 Response
Example Response:
[
{
"name": "Springfield - No Prefix (test)",
"promoters": 5,
"promotersPercent": 50,
"passive": 0,
"passivePercent": 0,
"detractors": 5,
"detractorsPercent": 50,
"totalResponses": 10,
"nps": 0
},
{
"name": "Total",
"promoters": 5,
"promotersPercent": 50,
"passive": 0,
"passivePercent": 0,
"detractors": 5,
"detractorsPercent": 50,
"totalResponses": 10,
"nps": 0
}
]
2.2.3 Implementation
- Used to retrieve NPS summaries of feedback data by pom, location or client.
- Used to generate NPS reporting.