| survey_group | integer | Represents the identifier of a survey group, which is a unique identifier for your Zencity survey. To obtain your survey group IDs, use the survey groups request, which returns your survey group IDs. You will need your survey group ID for specific requests as described in the documentation |
| survey_type | string | Represents the survey type to filter by. The options are: "blockwise," "community_survey," "pulse," and "customer_experience" |
| question_id | integer | Represents the identifier of a question. You will need your question_id |
| depth | integer | Represents the division’s depth, which is the geographical hierarchical level. For example, level 0 represents city/county-level data, and level 1 represents data for the highest hierarchical geographical areas under a city/county level (for example, division or districts) |
| division_layer_id | integer | Represents the identifier of a division layer, which is a specific geographical layer |
| polygon_name | array of strings | Represents polygon names. For Example: "Division 3" or "South Precinct". The polygon name indicates the area in your city/county that the requested data refers to |
| division_id | integer | Represents the identifier of a geographical division (area) |
| age_group_id | integer | Represents the identifier(s) of age group choice(s) |
| education_id | integer | Represents the identifier(s) of education choice(s) |
| income_id | integer | Represents the identifier(s) of income choice(s) |
| gender_id | integer | Represents the identifier(s) of gender choice(s) |
| ethnicity_id | integer | Represents the identifier(s) of ethnicity choice(s) |
| start_date | date | Represents the start date of requested submissions. The format for dates is YYYY-MM-DD. Start dates need to align with the cycle dates that are retrieved through the "Get Cycles" request." |
| end_date | date | Represents the end date of requested submissions. The format for dates is YYYY-MM-DD. End dates need to align with the cycle dates that are retrieved through the "Get Cycles" request" |
| aspect_id | integer | Represents the identifier of the aspect (see the full documentation for an explanation about aspects) |
| aspect_name | string | Represents aspects names. For Example: "Safety" or "Respect." |
| aspect_sentence | string | A sentence that describes an aspect and what it score measures |
| score_description | string | Describes the relationship between the scores and the sample size that was used to calculate it. The options are: "Representative," "Based on a small sample size," and "No score." See the "responses for scores based on small samples" for full details. |
| classification_sub_topic_value | string | Represents the sub-topic name in an open-ended question (relevant to the "Get Topics" request) |
| classification_topic_id | integer | Represents the identifier of a topic in an open-ended question (relevant to the "Get Topics" request) |
| classification_topic_value | string | Represents the topic name in an open-ended question (relevant to the "Get Topics" request) |
| responses | integer | Represents the number of responses assigned to a specific topic or sub-topic for open-ended questions (relevant to the "Get Topics" request) |
| total_submissions | integer | Total submissions for a specific question or aspect, including invalid submissions |
| total_valid_submissions | integer | Total valid submissions for a specific question or aspect, including invalid submissions. Valid responses are those that are nonmissing, that are from respondents over the age of 18, and those that live in the municipality. |
