Using the API to retrieve data

The following section will walk you through the GET requests to retrieve feedback data and/or summarised results.

2.1 Feedback Comments

This request will retrieve individual feedbacks.

The following fields are included in the response:

Key		Value Example		Format
createdDate		2017-02-09 23:30:00		DateTime
rating		5		Numeric
comment		Don’t change a thing!		Alpha
feedbackCode		ACSFTBWA		AlphaNumeric
feedbackDisplayId		95993ffa1b3911e7905d0225		Hexadecimal

 

2.1.1 Request

Method: GET

URL: api.feedback.fyi/feedback/search/?

Parameters:

Key	Value Example	Format	Req*	Details
pomId	1813	Numeric		Looks at all feedback under specified POM
locationId	462	Numeric		Looks at all feedback under specified Location
programmeId	25	Numeric		Looks at all feedback under specified Programme
pomId	22	Numeric		Looks at all feedback under specified Client
fromDate	1517270400	Timestamp		Specifies the date range to lookup from. Requires the toDate range to be specified to work.
toDate	1517443200	Timestamp		Specifies the date range to lookup until. Requires the fromDate range to be specified to work.
size	2	Numeric		This will limit the number of results. Maximum is 100. Default is 100.

Example with Params:

api.feedback.fyi/feedback/search/?pomId=1813&fromDate=1517270400&toDate=1517443200&size=2

2.1.2 Response

   {

       "createdDate": "2017-02-09 23:15:00",

       "rating": 5,

       "comment": "Don’t change a thing!",

       "feedbackCode": "ACSFTBWA",

       "feedbackDisplayId": "95993ffa1b3911e7905d0225f7a450af"

   }

2.1.3 Implementation

Used to publish feedback for display or reporting.