Get Topics

get

https://surveys-api.zencity.io/api/v2/answers_leading_sub_topics/

Description

This endpoint returns all topics and sub-topics (if available) for open-ended questions that are categorized by topics. Through the "Get Topics" request, the user receives the list of topics and sub-topics for a specific open-ended question. This allows users to map out what categorization topics are applied to their open-ended questions.

Query Params

survey_group

int32

Represents the identifier of a Survey Group to filter by. Either survey_group or survey_type filter must be provided. (know your survey group first)

survey_type

string

Represents the survey type to filter by, the options are: "blockwise", "community_survey", "pulse", "customer_experience". Either survey_group or survey_type filter must be provided.

start_date

date

Filtering by the submitted_at of a Submission (>=)

end_date

date

Filtering by the submitted_at of a Submission. (<=).

generic_question

int32

Represents the identifier of a Generic Question to filter by

gender

string

Comma separated integers, represents the identifier(s) of gender choice(s) to filter by.

ethnicity

string

Comma separated integers, represents the identifier(s) of ethnicity choice(s) to filter by.

age_group

string

Comma separated integers, represents the identifier(s) of age group choice(s) to filter by.

education

string

Comma separated integers, represents the identifier(s) of education choice(s) to filter by.

income

string

Comma separated integers, represents the identifier(s) of income choice(s) to filter by.

divisions

string

Comma separated integers, represents the identifier(s) of divisions of submission area to filter by.

Responses

Description

200200

400400