GET /surveys/{surveyId}/results returns a survey’s results per question, as the Results page in Usertick reads them, and requires the analytics:read scope.
What each question holds
Each question carries the blocks its type fills, andnull for the others:
Scores and averages come back unrounded, so round each value once where you show it.
Written answers, contact details and files aren’t here. Because they are what people wrote and sent, the API returns them as responses. Read them with
GET /responses and surveyId, which requires responses:read. For the same reason, removedQuestions (questions no longer in the survey that have answers) gives each one’s answer count and how many distinct values it holds, without the values.
Filters
The endpoint takes the Results page’s filters, and you can combine them.
When a value goes past what a filter takes, the call returns
400 and names the parameter instead of shortening or ignoring the value. An unknown time zone returns PUB-001-004, a filter value longer than any value it can match returns ANL-010-001, and more than 50 answer filters return ANL-010-002. An answer filter on a question no longer in the survey is listed in ignoredFilters, and every other filter still applies.
The window
As in the dashboard, the results cover what your plan keeps.window.from marks where the read starts, which is the from you sent, or the start of your plan’s response history when that is later. window.retentionFrom gives that start, and is null when your plan keeps every response.
partial is true when part of the read didn’t come back, such as the series or the window before. What came back is correct, and the missing parts are empty. When nothing can be read, the call returns 503 with ANL-001-503, and you can try again.