Get Answers

get

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

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

Path Params

survey_id

string

required

Unique ID of a survey

Query Params

api_key

string

Defaults to plugin.key

Concatenation of the plugin identifier and a unique user key.

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

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 ids. E.g. properties[color]=1,3,5

with_identity

boolean

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

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

404404

429429