--- updatedAt: 2025-06-09T22:41:54.000Z agentTools: projectIndex: https://docs.zenloop.com/llms.txt --- # Get Answers for Survey Group This endpoint is used for fetching survey group 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, "survey_public_hash_ids" : "RVlRV0ZzcTZ2SlZYZ1FoNGYxZ2FacENaeDVUeUFFazJvRXBFbTdWOUVKST0=,VE5UbEpjWXBjekl4UGQwWmRncUZ1ZXByMW93RzF0SFRibWJJRzFiNXZRRT0=" } ``` ## Response attributes | Attribute | Type | Description | | :-------------------------------------- | :----: | :------------------------------------------------------------------------------------ | | **survey\_group** | object | Survey group information data. | | survey\_group.**name** | string | Survey group name. | | survey\_group.**public\_hash\_id** | string | Survey group public hash id used to identify survey group. | | **properties** | array | List of properties for the survey group 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 group answers. | | answers.**id** | string | Answer identifier. | | answers.**survey\_public\_hash\_id** | string | Identifier for answer's survey | | 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\_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/survey_groups/{survey_group_id}/answers": { "get": { "summary": "Get Answers for Survey Group", "description": "This endpoint is used for fetching survey group answers along with basic survey data and aggregated NPS scores.", "operationId": "get-answers-for-survey-group", "parameters": [ { "name": "survey_group_id", "in": "path", "description": "Unique ID of a survey group", "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", "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 ids. E.g. `properties[color]=1,3,5`", "schema": { "properties": {}, "type": "object" } }, { "name": "survey_public_hash_ids", "in": "query", "description": "Filter by survey_public_hash_ids. Should be a list of comma-separated survey public hash ids", "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_group\": {\n \"public_hash_id\": \"dWVpS1J2VHU4V2w4WmdXaWtnMWEzUGx6N0s1TGxYSFp3SGM1UGU0NkxsTT0=\",\n \"name\": \"New Survey Group\",\n \"inserted_at\": \"2018-03-19T14:48:34Z\"\n },\n \"properties\": [],\n \"meta\": {\n \"total\": 3,\n \"per_page\": 50,\n \"page\": 1,\n \"total_pages\": 1\n },\n \"answers\": [\n {\n \"survey_public_hash_id\": \"RVlRV0ZzcTZ2SlZYZ1FoNGYxZ2FacENaeDVUeUFFazJvRXBFbTdWOUVKST0=\",\n \"score_type\": \"promoter\",\n \"score\": 10,\n \t\"sentiment\": \"positive\",\n \t\t\t\"sentiment_per_label_name\": {},\n \"recipient_id\": null,\n \"property_ids\": [],\n \"name\": \"anonymous\",\n \"metatags\": {},\n \"labels\": [],\n \t\"labels_with_keywords\": {},\n \"inserted_at\": \"2018-03-19T14:50:07Z\",\n \"identity_type\": null,\n \"identity\": null,\n \"id\": \"SFF0UXNaeXZncFl4UEVsMGRsNDJZREtwbXlGKzRWbXdlbXl2ZWUyTmJKZz0=\",\n \"email\": null,\n \"comment\": \"Very nice!\",\n \t\"translated_comment\": null, \n \t\"additional_questions\": {\n \t\t\t\t\"How was your day\": \"10\",\n \t\t\t\t\"Test question\": \"Test answer\",\n\t \t\t\t\t\t\"Which option would you pick\": \"Option A\",\n\t \t\t\t\t\t\"Which options would you pick\": [\"Option A\", \"Option B\"]\n \t\t\t}\n },\n {\n \"survey_public_hash_id\": \"VE5UbEpjWXBjekl4UGQwWmRncUZ1ZXByMW93RzF0SFRibWJJRzFiNXZRRT0=\",\n \"score_type\": \"promoter\",\n \"score\": 9,\n \t\"sentiment\": \"positive\",\n \t\t\t\"sentiment_per_label_name\": {\"Price\": \"neutral\"},\n \"recipient_id\": null,\n \"property_ids\": [],\n \"name\": \"anonymous\",\n \"metatags\": {},\n \"labels\": [\n \"Price\"\n ],\n \"labels_with_keywords\": {\n \t\t\t\t\"Price\": [\"offer\", \"sale\"]\n \t\t\t},\n \"inserted_at\": \"2018-03-19T14:52:52Z\",\n \"identity_type\": null,\n \"identity\": null,\n \"id\": \"MU5DUnlLOHpXeWNGTDBZRmh6cjZxakJHTElCZUROYjBQa1VPSFBWZFE3TT0=\",\n \"email\": null,\n \"comment\": \"Great value for the price!\",\n \t\"translated_comment\": null,\n \"additional_questions\": {}\n },\n {\n \"survey_public_hash_id\": \"VE5UbEpjWXBjekl4UGQwWmRncUZ1ZXByMW93RzF0SFRibWJJRzFiNXZRRT0=\",\n \"score_type\": \"passive\",\n \"score\": 7,\n \t\"sentiment\": \"neutral\",\n \t\t\t\"sentiment_per_label_name\": {},\n \"recipient_id\": null,\n \"property_ids\": [],\n \"name\": \"anonymous\",\n \"metatags\": {},\n \"labels\": [],\n \"labels_with_keywords\": {},\n \"inserted_at\": \"2018-03-19T14:50:40Z\",\n \"identity_type\": null,\n \"identity\": null,\n \"id\": \"NUJLRHpNMXlhZHZ1V0xBOWFnditCU2o1cHROZS9LKzFWZjZQNlBVRmNLOD0=\",\n \"email\": null,\n \"comment\": \"It was ok\",\n \t\"translated_comment\": null,\n \t\"additional_questions\": {}\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "survey_group": { "type": "object", "properties": { "public_hash_id": { "type": "string", "example": "dWVpS1J2VHU4V2w4WmdXaWtnMWEzUGx6N0s1TGxYSFp3SGM1UGU0NkxsTT0=" }, "name": { "type": "string", "example": "New Survey Group" }, "inserted_at": { "type": "string", "example": "2018-03-19T14:48:34Z" } } }, "properties": { "type": "array" }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "example": 3, "default": 0 }, "per_page": { "type": "integer", "example": 50, "default": 0 }, "page": { "type": "integer", "example": 1, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 } } }, "answers": { "type": "array", "items": { "type": "object", "properties": { "survey_public_hash_id": { "type": "string", "example": "RVlRV0ZzcTZ2SlZYZ1FoNGYxZ2FacENaeDVUeUFFazJvRXBFbTdWOUVKST0=" }, "score_type": { "type": "string", "example": "promoter" }, "score": { "type": "integer", "example": 10, "default": 0 }, "sentiment": { "type": "string", "example": "positive" }, "sentiment_per_label_name": { "type": "object", "properties": {} }, "recipient_id": {}, "property_ids": { "type": "array" }, "name": { "type": "string", "example": "anonymous" }, "metatags": { "type": "object", "properties": {} }, "labels": { "type": "array" }, "labels_with_keywords": { "type": "object", "properties": {} }, "inserted_at": { "type": "string", "example": "2018-03-19T14:50:07Z" }, "identity_type": {}, "identity": {}, "id": { "type": "string", "example": "SFF0UXNaeXZncFl4UEVsMGRsNDJZREtwbXlGKzRWbXdlbXl2ZWUyTmJKZz0=" }, "email": {}, "comment": { "type": "string", "example": "Very nice!" }, "translated_comment": {}, "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 \"title\": \"Invalid request body.\",\n \"status\": 400,\n \"links\": {\n \"documentation\": \"https://docs.zenloop.com/v1.0/reference#get-answers-for-survey-group\"\n },\n \"details\": [\n {\n \"pointer\": \"/answer_type\",\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\"\n },\n {\n \"pointer\": \"/date_shortcut\",\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\"\n },\n {\n \"pointer\": \"/order_by\",\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\"\n },\n {\n \"pointer\": \"/order_type\",\n \"detail\": \"Value \\\"\\\" is not allowed in enum.\"\n }\n ],\n \"code\": \"INVALID_REQUEST\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "title": { "type": "string", "example": "Invalid request body." }, "status": { "type": "integer", "example": 400, "default": 0 }, "links": { "type": "object", "properties": { "documentation": { "type": "string", "example": "https://docs.zenloop.com/v1.0/reference#get-answers-for-survey-group" } } }, "details": { "type": "array", "items": { "type": "object", "properties": { "pointer": { "type": "string", "example": "/answer_type" }, "detail": { "type": "string", "example": "Value \"\" is not allowed in enum." } } } }, "code": { "type": "string", "example": "INVALID_REQUEST" } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"title\": \"Invalid or expired token.\",\n \"status\": 401,\n \"code\": \"UNAUTHORIZED\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "title": { "type": "string", "example": "Invalid or expired token." }, "status": { "type": "integer", "example": 401, "default": 0 }, "code": { "type": "string", "example": "UNAUTHORIZED" } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"title\": \"Survey Group not found.\",\n \"status\": 404,\n \"code\": \"NOT_FOUND\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "title": { "type": "string", "example": "Survey Group not found." }, "status": { "type": "integer", "example": 404, "default": 0 }, "code": { "type": "string", "example": "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 } ```