Get Survey Answers

GET
https://rest.edapp.com/v2/analytics/surveyanswers

Description
A survey in EdApp is a type of slide template that can be added to a lesson to extract information from a learner. This information can include ratings, free text responses, and multiple-choice questions. Surveys have no correct answer, they are a tool to gather information and opinion from learners. This endpoint returns data on all survey answers that learners have given within an EdApp account.

A GET request to this endpoint will return all of the answers a user has given to survey slides in EdApp. Additional parameters such as LessonId and CourseId can be added to the request for a more focused result.

Parameters

Parameter Description Data Type
CourseId (Optional)

Ed CourseId

string
CourseExternalId (Optional)

External Id’s are an optional addition to a course that allow for easier referencing of the course through the API.

string
LessonId (Optional)

Ed LesssonId

string
LessonExternalId (Optional)

External Id’s are an optional addition to a lesson that allow for easier referencing of the lesson through the API.

string
UserId

Ed UserId

string
UserExternalId

External Id’s are an optional addition to a user’s profile that allow for easier referencing of the user through the API.

string
StartDateTime

DateTime filter on the answeredDateTime field

date-time

"2020-01- 16T04:27:48. 195Z"

EndDateTime

DateTime filter on the AnsweredDateTime field

date-time

"2020-01- 16T04:27:48. 195Z"

Page (Optional)

Page number to retrieve

Value > 1

integer

PageSize (Optional)

Number of records per page Value 1-1000

integer

 

Response

Field Description Data Type
TotalCount

The total number of records the query returns

Integer
Items

An array of the records for the requested page

Array
courseId

Ed courseId

string
courseExternalId

External Id’s are an optional addition to a course that allow for easier referencing of the course through the API.

string
lessonId

Ed lessonId

string
lessonExternalId

External Id’s are an optional addition to a lesson that allow for easier referencing of the lesson through the API.

string
slideId

Ed slideId

string
userId

Ed userId

string
userExternalId

External Id’s are an optional addition to a user’s profile that allow for easier referencing of the user through the API.

string
attemptId

Ed attemptId

string
questionId

Ed questionId

string
questionContent

The content of the question. This can be text or a url to a picture or video

string
answerDefinitionId

Ed answerDefinitionId. This is only populated in case of a multiple choice question

string
answerContent

The content of the answer. This can be text or a url to a picture or video.

string
answeredDateTime

The date time the user answered the question

datetime


Example

{
"totalCount": 0,
"items": [
{
"id": "string",
"courseId": "string",
"courseExternalId": "string",
"lessonId": "string",
"lessonExternalId": "string",
"lessonTitle": "string",
"userExternalId": "string",
"attemptId": "string",
"questionId": "string",
"questionContent": "string",
"answerDefinitionId": "string",
"answerContent": "string",
"answeredDateTime": "2018-04-30T07:22:13.512Z"
}
]
}