Skip to content

Get Survey Report

This endpoint will retrieve the report for a survey

Request

GET /accounts/{account-uuid}/surveys/{survey-uuid}/report
  • account-uuid is a 22-character identifier for the account
  • survey-uuid is a 22-character identifier for the survey

Authorization

Authorization header is required for this endpoint. See Authorization Tokens for details about auth tokens.

Headers

N/A

Query Parameters

N/A

Response

Response Status Code More Information
Success 200 Survey exists with provided UUID. Response body will have details
Not Found 404 Survey does not exist with the provided UUID
Unauthorized 401 If user is not authorized for the requested survey
Internal Server Error 500 Unknown error

Headers

N/A

Body

Will contain the report version of the survey data.

Some notes about the response body format:

  • Basic information about the survey will be at the root of the data field, such as the survey title, and when it was executed.
  • The first level of surveyItems will contain the groups (indicated by the itemType field).
  • Each group will have its own set of surveyItems that will contain the questions within each group