--- updatedAt: 2025-06-09T22:41:53.000Z agentTools: projectIndex: https://docs.zenloop.com/llms.txt --- # Get Answers This endpoint is used for fetching survey answers along with basic survey data and aggregated NPS scores. ```json Example request { "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. | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api", "version": "1.0" }, "servers": [ { "url": "https://api.zenloop.com" } ], "security": [ {} ], "paths": { "/v1/surveys/{survey_id}/answers": { "get": { "summary": "Get Answers", "description": "This endpoint is used for fetching survey answers along with basic survey data and aggregated NPS scores.", "operationId": "get-answers", "parameters": [ { "name": "survey_id", "in": "path", "description": "Unique ID of a survey", "schema": { "type": "string" }, "required": true }, { "name": "date_shortcut", "in": "query", "description": "Date range for which we want to fetch answers. Allowed values: `today`, `yesterday`, `last_week`, `last_month`, `last_7_days`, `last_30_days`, `all_time`, `custom`", "schema": { "type": "string", "default": "all_time" } }, { "name": "comment_content", "in": "query", "description": "Comment content filter for the answers.", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "Result sort. Allowed values: `rating`, `inserted_at`", "schema": { "type": "string" } }, { "name": "order_type", "in": "query", "description": "Sort answer ascending or descending. Allowed values: `asc`, `desc`", "schema": { "type": "string", "default": "desc" } }, { "name": "with_comments", "in": "query", "description": "Filters answer with comments only. Allowed values: `true`, `false`", "schema": { "type": "boolean" } }, { "name": "answer_type", "in": "query", "description": "Filters particular answers type only. Allowed values: `detractors`, `passives`, `promoters`", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Number of the page of the results you would like to get.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "default": "Bearer " } }, { "name": "properties[color]", "in": "query", "description": "Filter by properties. The key should be the name of the property, the value should be a list of comma-separated property public hash ids. E.g. `properties[color]=RkJrQllReklDTmk0cmRtTUVMUGw2SWJKUStHTk1lZG5WMFppSUIzdmxvOD0=,czhlUW5yZXdNR0t5eW16T3A5OWx3RXJnV2FNaDNEc0J1K2FMdGFUSVRwMD0=`", "schema": { "type": "string" } }, { "name": "with_identity", "in": "query", "description": "Value `true` returns only answers with identity. Value `false` returns only answers without identity.", "schema": { "type": "boolean" } }, { "name": "date_from", "in": "query", "description": "Parameter required when date_shortcut is set to `custom`. Filters answers only received after specific datetime. Format: `2021-10-24T03:30:30Z` or `2021-10-24`", "schema": { "type": "string", "format": "date" } }, { "name": "date_to", "in": "query", "description": "Parameter required when date_shortcut is set to `custom`. Filters answers only received before specific datetime. Format: `2021-10-24T03:30:30Z` or `2021-10-24`", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"survey\": {\n \"title\": \"After Checkout DE\",\n \"status\": \"active\",\n \"public_hash_id\": \"RWVJTzN3MkJTSklMMEUxMFVJdm5VN1hEZVIvWnhpZ1lGdEZ3a25ET25tWT0=\",\n \"inserted_at\": \"2017-01-26T12:31:44Z\"\n },\n \"properties\": [\n {\"value\": \"germany\", \"name\": \"country\", \"id\": 2},\n {\"value\": \"blue\", \"name\": \"color\", \"id\": 6},\n {\"value\": \"uk\", \"name\": \"country\", \"id\": 4},\n {\"value\": \"white\", \"name\": \"color\", \"id\": 7},\n {\"value\": \"1350\", \"name\": \"value\", \"id\": 12},\n {\"value\": \"GBP\", \"name\": \"currency\", \"id\": 14},\n {\"value\": \"france\", \"name\": \"country\", \"id\": 3},\n {\"value\": \"green\", \"name\": \"color\", \"id\": 8},\n {\"value\": \"1000\", \"name\": \"value\", \"id\": 9},\n {\"value\": \"EUR\", \"name\": \"currency\", \"id\": 13}\n ],\n \"meta\": {\n \"total\": 4,\n \"per_page\": 20,\n \"page\": 1,\n \"total_pages\": 1\n },\n \"answers\": [\n {\n \"id\": \"NVdYMTRPOVZnb0NmeWhTUVljMmplR2p6MS9kTTBFem4vZ1VGZDJ5WVhycz0=\",\n \"score_type\": \"passive\",\n \"score\": 8,\n \"sentiment\": \"neutral\",\n \"sentiment_per_label_name\": {\"Voucher\": \"neutral\"},\n \"recipient_id\": \"NnE0US9DZElTS25NNEU1QTcxL3BLOEVGcHNLV3FaWnJKeXNFd2svVGtIcz0=\",\n \"property_ids\": [3, 8, 9, 13],\n \"metatags\": {\n \"thank_you_note_all\": \"Thanks for your feedback about metatags!\",\n \"survey_question\": \"how do you like our product %[question subject]?\",\n \"request_for_comment_all\": \"Tell us a bit more about why you chose %[score] for metatags\",\n \"question_subject\": \"metatags\"\n },\n \"labels\": [\"Voucher\"],\n \"labels_with_keywords\": {\n \t\"Voucher\": [\"coupon\", \"voucher\"]\n },\n \"name\": \"Maxine Jacobs\",\n \"inserted_at\": \"2017-01-26T12:31:46.736219Z\",\n \"email\": \"test_1@test.com\",\n \"identity\": \"test_1@test.com\",\n \"identity_type\": \"email\",\n \"comment\": \"Hi Team, having problems with the voucher code…can you get back to me\",\n \"translated_comment\": null,\n \"additional_answers\": [\n {\n \"additional_question_id\": \"30pVRkMvb2JzQUwrRjkxaeJzMjFUSTJ4ZnFtTllIalcyeVdweCsrRnVEbz0=\",\n \"answer\": \"Test answer\",\n \"inserted_at\": \"2019-05-28T09:45:12.774342Z\"\n }\n ],\n \"additional_questions\": {\n \t\"How was your day\": \"10\",\n \t\"Test question\": \"Test answer\",\n\t \t\t\"Which option would you pick\": \"Option A\",\n\t \t\t\"Which options would you pick\": [\"Option A\", \"Option B\"]\n }\n },\n {\n \"id\": \"REEvd2RzZzlOMUZFWnR1RFBGWjlpNEphZWE5Y1pteG9LTU5wQjN3dTNlcz0=\",\n \"score_type\": \"promoter\",\n \"score\": 9,\n \"sentiment\": \"positive\",\n \"sentiment_per_label_name\": {},\n \"recipient_id\": \"R1FEaUNTSUxhMjBsUHFiUWl2Z0RIV3BHeWZpT0l6eE5oaVVJMVNnT3NXdz0=\",\n \"property_ids\": [4, 7, 12, 14],\n \"metatags\": {\n \"thank_you_note_all\": \"Thanks for your feedback about metatags!\",\n \"survey_question\": \"how do you like our product %[question subject]?\",\n \"request_for_comment_all\": \"Tell us a bit more about why you chose %[score] for metatags\",\n \"question_subject\": \"metatags\"\n },\n \"labels\": [],\n \"labels_with_keywords\": {},\n \"name\": \"John Finley\",\n \"inserted_at\": \"2017-01-26T08:55:46.740574Z\",\n \"email\": \"test_2@test.com\",\n \"comment\": null,\n \"translated_comment\": null,\n \"additional_answers\": [],\n \"additional_questions\": {}\n },\n {\n \"id\": \"Q2VEL1dQR3hzRUZxckZBOWNhQ3hGM0JMZzhYSWhSaTc3dnEwbGNPbUEvZz0=\",\n \"score_type\": \"detractor\",\n \"score\": 5,\n \"sentiment\": \"neutral\",\n \"sentiment_per_label_name\": {\"Product\": \"neutral\"},\n \"recipient_id\": \"V1Npazk1a09oNDlKcXVYb1NpTUJUSlhMczYrZVM3ZTFLcHV1YmNUZmFOWT0=\",\n \"property_ids\": [2, 6],\n \"metatags\": {\n \"thank_you_note_all\": \"Thanks for your feedback about metatags!\",\n \"survey_question\": \"how do you like our product %[question subject]?\",\n \"request_for_comment_all\": \"Tell us a bit more about why you chose %[score] for metatags\",\n \"question_subject\": \"metatags\"\n },\n \"labels\": [\"Product\"],\n \"labels_with_keywords\": {\n \t\"Product\": [\"brand\", \"quality\", \"design\"]\n },\n \"name\": \"Irene Adams\",\n \"inserted_at\": \"2017-01-26T05:19:46.744313Z\",\n \"email\": \"test_3@test.com\",\n \"identity\": \"test_3@test.com\",\n \"identity_type\": \"email\",\n \"comment\": \"Site is too slow, and I can't order by phone. But the product turned up really quickly\",\n \"translated_comment\": null,\n \"additional_answers\": [],\n \"additional_questions\": {}\n },\n {\n \"id\": \"TVZDa1Z2K0JJaWhwU3ZodzY3YjRDV01SWWhYQ0MwWHpCS1FzVktnaWprOD0=\",\n \"score_type\": \"promoter\",\n \"score\": 9,\n \"sentiment\": \"positive\",\n \"sentiment_per_label_name\": {},\n \"recipient_id\": \"TksyMGxsd215dFpON2s0S2NVbk50M0hHT3NqeDlscjNyTnAvaExEL3JYND0=\",\n \"property_ids\": [2, 6],\n \"metatags\": {\n \"thank_you_note_all\": \"Thanks for your feedback about metatags!\",\n \"survey_question\": \"how do you like our product %[question subject]?\",\n \"request_for_comment_all\": \"Tell us a bit more about why you chose %[score] for metatags\",\n \"question_subject\": \"metatags\"\n },\n \"labels\": [],\n \"labels_with_keywords\": {},\n \"name\": \"Denise Moore\",\n \"inserted_at\": \"2017-01-26T01:43:46.74778Z\",\n \"email\": \"test_4@test.com\",\n \"identity\": \"test_4@test.com\",\n \"identity_type\": \"email\",\n \"comment\": null,\n \"translated_comment\": null,\n \"additional_answers\": [],\n \"additional_questions\": {}\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "survey": { "type": "object", "properties": { "title": { "type": "string", "example": "After Checkout DE" }, "status": { "type": "string", "example": "active" }, "public_hash_id": { "type": "string", "example": "RWVJTzN3MkJTSklMMEUxMFVJdm5VN1hEZVIvWnhpZ1lGdEZ3a25ET25tWT0=" }, "inserted_at": { "type": "string", "example": "2017-01-26T12:31:44Z" } } }, "properties": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "example": "germany" }, "name": { "type": "string", "example": "country" }, "id": { "type": "integer", "example": 2, "default": 0 } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "example": 4, "default": 0 }, "per_page": { "type": "integer", "example": 20, "default": 0 }, "page": { "type": "integer", "example": 1, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 } } }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "NVdYMTRPOVZnb0NmeWhTUVljMmplR2p6MS9kTTBFem4vZ1VGZDJ5WVhycz0=" }, "score_type": { "type": "string", "example": "passive" }, "score": { "type": "integer", "example": 8, "default": 0 }, "sentiment": { "type": "string", "example": "neutral" }, "sentiment_per_label_name": { "type": "object", "properties": { "Voucher": { "type": "string", "example": "neutral" } } }, "recipient_id": { "type": "string", "example": "NnE0US9DZElTS25NNEU1QTcxL3BLOEVGcHNLV3FaWnJKeXNFd2svVGtIcz0=" }, "property_ids": { "type": "array", "items": { "type": "integer", "example": 3, "default": 0 } }, "metatags": { "type": "object", "properties": { "thank_you_note_all": { "type": "string", "example": "Thanks for your feedback about metatags!" }, "survey_question": { "type": "string", "example": "how do you like our product %[question subject]?" }, "request_for_comment_all": { "type": "string", "example": "Tell us a bit more about why you chose %[score] for metatags" }, "question_subject": { "type": "string", "example": "metatags" } } }, "labels": { "type": "array", "items": { "type": "string", "example": "Voucher" } }, "labels_with_keywords": { "type": "object", "properties": { "Voucher": { "type": "array", "items": { "type": "string", "example": "coupon" } } } }, "name": { "type": "string", "example": "Maxine Jacobs" }, "inserted_at": { "type": "string", "example": "2017-01-26T12:31:46.736219Z" }, "email": { "type": "string", "example": "test_1@test.com" }, "identity": { "type": "string", "example": "test_1@test.com" }, "identity_type": { "type": "string", "example": "email" }, "comment": { "type": "string", "example": "Hi Team, having problems with the voucher code…can you get back to me" }, "translated_comment": {}, "additional_answers": { "type": "array", "items": { "type": "object", "properties": { "additional_question_id": { "type": "string", "example": "30pVRkMvb2JzQUwrRjkxaeJzMjFUSTJ4ZnFtTllIalcyeVdweCsrRnVEbz0=" }, "answer": { "type": "string", "example": "Test answer" }, "inserted_at": { "type": "string", "example": "2019-05-28T09:45:12.774342Z" } } } }, "additional_questions": { "type": "object", "properties": { "How was your day": { "type": "string", "example": "10" }, "Test question": { "type": "string", "example": "Test answer" }, "Which option would you pick": { "type": "string", "example": "Option A" }, "Which options would you pick": { "type": "array", "items": { "type": "string", "example": "Option A" } } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"status\": 400,\n \"code\": \"INVALID_REQUEST\",\n \"links\": {\n \"documentation\": \"https://docs.zenloop.com/v1.0/reference#get-answers\"\n },\n \"title\": \"Invalid request body.\",\n \"details\": [\n {\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\",\n \"pointer\": \"/answer_type\"\n },\n {\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\",\n \"pointer\": \"/date_shortcut\"\n },\n {\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\",\n \"pointer\": \"/order_by\"\n },\n {\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\",\n \"pointer\": \"/order_type\"\n }\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "code": { "type": "string", "example": "INVALID_REQUEST" }, "links": { "type": "object", "properties": { "documentation": { "type": "string", "example": "https://docs.zenloop.com/v1.0/reference#get-answers" } } }, "title": { "type": "string", "example": "Invalid request body." }, "details": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string", "example": "Value \"\" is not allowed in enum." }, "pointer": { "type": "string", "example": "/answer_type" } } } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"status\": 401,\n \"code\": \"UNAUTHORIZED\",\n \"title\": \"Invalid or expired token.\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "code": { "type": "string", "example": "UNAUTHORIZED" }, "title": { "type": "string", "example": "Invalid or expired token." } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"title\": \"Survey not found.\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "example": 404, "default": 0 }, "code": { "type": "string", "example": "NOT_FOUND" }, "title": { "type": "string", "example": "Survey not found." } } } } } } } }, "429": { "description": "429", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"title\": \"Rate limit exceeded.\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "example": 429, "default": 0 }, "code": { "type": "string", "example": "TOO_MANY_REQUESTS" }, "title": { "type": "string", "example": "Rate limit exceeded." } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "Content-Type", "value": "application/json" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```