get https://api.zenloop.com/v1/surveys//answers
This endpoint is used for fetching survey answers along with basic survey data and aggregated NPS scores.
{
"date_shortcut": "all_time",
"comment_content": "great",
"order_by": "rating",
"order_type": "asc",
"with_comments": true,
"answer_type": "promoters",
"properties" : {"color" : "RkJrQllReklDTmk0cmRtTUVMUGw2SWJKUStHTk1lZG5WMFppSUIzdmxvOD0=,czhlUW5yZXdNR0t5eW16T3A5OWx3RXJnV2FNaDNEc0J1K2FMdGFUSVRwMD0=",
"country" : "Yzg4TDJwVnNtNDM2Nm1Ca2hpdjMrUmdBODN4Z1Blb053cFB3eFo4MmR4dz0="},
"page": 1
}
Response attributes
Attribute | Type | Description |
---|---|---|
survey | object | Survey information data. |
survey.title | string | Survey title. |
survey.status | string | Survey status. One of: draft , active |
survey.public_hash_id | string | Survey public hash id used to identify survey. |
survey.inserted_at | date | Survey creation date. |
properties | array | List of properties for the survey answers. |
properties.name | string | Property name. |
properties.value | string | Property value. |
properties.id | number | Property Id. |
meta | object | Result metadata. |
meta.total | number | Number of answers. |
meta.total_pages | number | Number of pages. |
meta.per_page | number | Number of answers per page. |
meta.page | number | Current results page. |
answers | array | Survey answer. |
answers.id | string | Answer identifier. |
answers.score_type | string | Score type for the answer. |
answers.score | number | Actual score for the answer. |
answers.sentiment | number | Overall sentiment of the answer. |
answers.sentiment_per_label_name | object | Sentiment of the specific label. |
answers.name | string | Name of survey recipient who submitted the answer. |
answers.recipient_id | string | ID of a recipient who submitted the answer. |
answers.property_ids | array | Array of property identifiers for the answer. |
answers.metatags | object | List of metatags for the answer. |
answers.labels | array | List of labels for the answer. |
answers.labels_with_keywords | object | Label names with keywords. |
answers.inserted_at | date | Date when an answer has been submitted. |
answers.email | string | Email of survey recipient who submitted the answer. Deprecated |
answers.identity | string | Identity of survey recipient who submitted the answer. |
answers.identity_type | string | Identity type of survey recipient who submitted the answer. One of: email , custom |
answers.comment | string | Answer comment of survey recipient who submitted the answer. |
answers.translated_comment | string | Translated comment. |
answers.additional_answers | object | Additional answers. |
answers.additional_answers.additional_question_id | string | Additional question public_hash_id. |
answers.additional_answers.answer | string | Additional answer content. |
answers.additional_answers.inserted_at | date | Date when an answer was submitted. |
answers.additional_questions | object | Additional answers - questions with answers. |