API Reference

Description

This endpoint returns all aspect scores for the client (positive scores).

In Zencity surveys, aspect is the term used to define a set of questions that measure and provide a score for a specific concept or KPI. The aspect score is calculated by averaging the question scores for that aspect. (for example, in Blockwise surveys, there are two questions under the "respect" aspect. Averaging the positive scores of both of these questions creates the aspect score for "respect").

Aspect scores can be filtered by:
Geographical division AND/OR Demographics (Age, Ethnicity, Gender, Education, Income)

The endpoint will return the aspect scores for all aspects that are defined on your Zencity survey. The standard Blockwise aspects are Safety, Respect, Voice, and Fairness.

The start_date and end_data params are required. These dates need to align with the cycle dates that are retrieved through the Get Cycles endpoint. The survey_group param is also required and should be retrieved through the Get Survey Groups endpoint.

Sample sizes are addressed in the "score_description" field. In the Zencity dashboard, we do not display scores that are based on samples that are smaller than 30 respondents. When requesting data through the Get Aspects request, the response will not return scores that are based on a sample size lower than 30. The API response under "score description" will return the following value: "No score". When scores are based on a sample size of 30 to 49 responses, the API response under "score description" will return the following value: "Based on a small sample size". A "Representative" response in the "score_description" field means that the score was based on a N>49 sample.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!