Get Answers

get

https://api.zenloop.com/v1/surveys/{survey_id}/answers

This endpoint is used for fetching survey answers along with basic survey data and aggregated NPS scores.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

survey_id

string

required

Unique ID of a survey

Query Params

date_shortcut

string

Defaults to all_time

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

comment_content

string

Comment content filter for the answers.

order_by

string

Result sort. Allowed values: rating, inserted_at

order_type

string

Defaults to desc

Sort answer ascending or descending. Allowed values: asc, desc

with_comments

boolean

Filters answer with comments only. Allowed values: true, false

answer_type

string

Filters particular answers type only. Allowed values: detractors, passives, promoters

page

int32

Defaults to 1

Number of the page of the results you would like to get.

properties[color]

string

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=

with_identity

boolean

Value true returns only answers with identity. Value false returns only answers without identity.

date_from

date

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

date_to

date

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

Headers

Authorization

string

required

Defaults to Bearer <token>

Responses

200200

400400

401401

404404

429429