Skip to content

Customer feedback

Returns list of customer feedback in the system. Returned data can be limited with start and end query parameters.

Operations

Download customer feedback as JSON

Request

GET https://api.zoined.com/v2/download/customerFeedbacks.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/customerFeedbacks.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
feedback_idstringrequired

Unique ID for this feedback entry

Example:"xyz"
respondent_idstring

Optional ID for survey respondent. Can be used to group all responses by single respondent.

Example:"1234"
survey_idstring

Optional ID for survey. Can be used to separate responses between different surveys.

Example:"Survey 1"
question_idstring

Optional ID for feedback question. Should be used if multiple separate feedback questions are needed.

Example:"Q1"
organisation_idstringrequired

Identifier of store this feedback entry refers to

Example:"ORG1"
department_idstring

Optional identifier of department this feedback entry refers to

Example:"DEP1"
feedback_datestringrequired

Date of feedback (yyyy-mm-dd)

Example:"2018-01-01"
feedback_timestring

Optional time of feedback (hh:mm:ss)

Example:"15:00:00"
feedback_typestring

Optional type of feedback

Example:"Store survey"
main_feedbackboolean

Is this main (overall grade) feedback. Default is true

Example:true
gradenumberrequired

Numerical grade for feedback

Example:9
grade_totalnumber

Optional numerical total grade calculated by source (eg. Google Review) for feedback

Example:8.5
commentsstring

Optional free form feedback

Example:"Great service today!"
comments_enstring

Optional free form feedback translated in English

Example:"Great service today!"
review_urlstring

Google review URL

Example:"https://www.google.com/maps/reviews?data=XYZ"
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
Response
{
  "feedback_id": "xyz",
  "respondent_id": "1234",
  "survey_id": "Survey 1",
  "question_id": "Q1",
  "organisation_id": "ORG1",
  "department_id": "DEP1",
  "feedback_date": "2018-01-01",
  "feedback_time": "15:00:00",
  "feedback_type": "Store survey",
  "main_feedback": true,
  "grade": 9,
  "grade_total": 8.5,
  "comments": "Great service today!",
  "comments_en": "Great service today!",
  "review_url": "https://www.google.com/maps/reviews?data=XYZ",
  "custom_field_1": "XYZ",
  "custom_field_2": "XYZ",
  "custom_field_3": "XYZ",
  "custom_field_4": "XYZ",
  "custom_field_5": "XYZ"
}