Search for course feedback

  • Updated on Jul 16, 2024
  • 3 minute(s) read
Prev Next
Get
/SearchCourseFeedback

Allows you to search for course feedback.

Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)

A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).

pageSize
integer (int32)

Indicates how many results you want per page. if not supplied, a default value of 100 is used.

sort
string

The value you want to sort by. If not supplied, a default value of "Created" will be used. You can append " DESC" after the sort value to sort descending. For example, "Created DESC" would sort by created date in descending order. Possible values:

  • Created
  • Title
  • Content
  • Positive
  • Negative
  • User
  • CourseAssignment
  • Course
  • Class
  • ClassEnrollment
  • Activity
  • ActivityType
courseId
integer (int32)

An optional parameter used to filter for a course by Id. When specified, only feedback entries for the specified course will be returned.

name
string

An optional parameter used to filter for courses by name. When specified, only feedback entries for courses that have names that contain or match this value will be returned.

createdAfter
integer (int64) | null

An optional parameter used to filter for feedback entries created after a specified date. When used in conjunction with the "createdBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

createdBefore
integer (int64) | null

An optional parameter used to filter for feedback entries created before a specified date. When used in conjunction with the "createdAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

TotalCount
integer (int32)

The total number of results that match the search conditions, not all of which may be in the current result set.

Example1
TotalPages
integer (int32)

The total number of result pages that match the search conditions.

Example1
Results
Array of object (CourseFeedbackSearchResult)

See CourseFeedbackSearchResult

object
Submitted
integer (int64)

When the feedback entry was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

Example1492203295
CourseId
integer (int32)

The Id of the course.

Example1234
CourseName
string

The name of the course.

ExampleCourse 1234 name sample
Title
string

The title of the feedback message.

ExampleCourse 1234 title sample
Content
string | null

The text content of the feedback message.

ExampleCourse content sample
Positive
boolean

Indicates whether the feedback is positive.

ExampleFalse
Negative
boolean

Indicates whether the feedback is negative.

ExampleTrue
UserId
integer (int32) | null

The Id of the user (if available) of the user that submitted the feedback.

Example279207
UserExternalId
string | null

The ExternalId of the user (if available) of the user that submitted the feedback.

Example831ab062-fcd9-44c7-9ffd-15ef98e9746e
CourseAssignmentId
integer (int32) | null

The Id of the course assignment (if any).

Example68905
ClassEnrollmentId
integer (int32) | null

The Id of the class enrollent (if any).

Example4576
ActivityId
integer (int32) | null

The Id of the activity (if any).

Example123
ActivityTypeId
integer (int32) | null

The Id of the activity type (if any)

  • ScormModule = 2
  • Lab = 4
  • Survey = 10
  • InstructorSurvey = 20
  • OrganizationSurvey = 30
  • ExternalLink = 40
  • Assessment = 50
  • Video = 60
  • Document = 70
Example123
ActivityName
string | null

The activity's name (if any)

ExampleSample activity name