Skip to content

Customer feedback

Customer feedback endpoint can be used to upload either free form survey results or satisfaction grades.

Operations

Upload list of customer feedback

Request

POST https://api.zoined.com/customerFeedbacks?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=true
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
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"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/customerFeedbacks?dryRun=true&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

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

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}