Skip to content

Returns the paginated quiz attempts across a whole course, each with the student profile and the lesson attached.

search matches student name, username or quiz title. filter_by accepts passed, failed or published; the client value n/a is mapped to published, which is the ungraded state.

Endpoint

  • Method: GET

  • Path: /admin/courses/{course_id}/quiz-results

  • Edition: PRO

  • Controller: FluentCommunityPro\App\Modules\Quiz\Http\Controllers\QuizController@getCourseQuizResults

  • Route source: fluent-community-pro/app/Modules/Quiz/Http/quiz_api.php:13

  • Requires a course admin for this course, or a WordPress user with manage_options.

  • Requires FluentCommunity Pro with the Quiz module.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET List Course Quiz Results

GET
/admin/courses/{course_id}/quiz-results

Returns the paginated quiz attempts across a whole course, each with the student profile and the lesson attached.

Controller: FluentCommunityPro\App\Modules\Quiz\Http\Controllers\QuizController@getCourseQuizResults
Route source: fluent-community-pro/app/Modules/Quiz/Http/quiz_api.php:13

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"results": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"content_type": "string",
  
  
  
  
"id": 0,
  
  
  
  
"lesson": {
  
  
  
  
  
"comments_count": 0,
  
  
  
  
  
"content_type": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"expired_at": "string",
  
  
  
  
  
"featured_image": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"is_sticky": "string",
  
  
  
  
  
"message": "string",
  
  
  
  
  
"message_rendered": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"auto_complete_on_video_end": "string",
  
  
  
  
  
  
"document_ids": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"document_lists": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"enable_comments": "string",
  
  
  
  
  
  
"enable_media": "string",
  
  
  
  
  
  
"enable_passing_score": "string",
  
  
  
  
  
  
"enforce_passing_score": "string",
  
  
  
  
  
  
"free_preview_lesson": "string",
  
  
  
  
  
  
"hide_result": "string",
  
  
  
  
  
  
"media": {
  
  
  
  
  
  
  
"provider": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"passing_score": 0,
  
  
  
  
  
  
"quiz_questions": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
"enabled": true,
  
  
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
  
  
"label_rendered": "string",
  
  
  
  
  
  
  
  
"options": [
  
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
  
"is_correct": true,
  
  
  
  
  
  
  
  
  
  
"label": "string"
  
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
  
"slug": "string",
  
  
  
  
  
  
  
  
"type": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"require_video_completion": "string",
  
  
  
  
  
  
"video_completion_threshold": 0,
  
  
  
  
  
  
"video_length": 0
  
  
  
  
  
},
  
  
  
  
  
"parent_id": "string",
  
  
  
  
  
"priority": "string",
  
  
  
  
  
"privacy": "string",
  
  
  
  
  
"reactions_count": 0,
  
  
  
  
  
"scheduled_at": "string",
  
  
  
  
  
"slug": "string",
  
  
  
  
  
"space_id": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"type": "string",
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": "string"
  
  
  
  
},
  
  
  
  
"message": {
  
  
  
  
  
"q1": {
  
  
  
  
  
  
"is_correct": true,
  
  
  
  
  
  
"user_answer": "string"
  
  
  
  
  
},
  
  
  
  
  
"q2": {
  
  
  
  
  
  
"is_correct": true,
  
  
  
  
  
  
"user_answer": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
]
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"meta": {
  
  
  
  
  
"attempts": 0,
  
  
  
  
  
"correct_answers": 0,
  
  
  
  
  
"total_questions": 0
  
  
  
  
},
  
  
  
  
"parent_id": "string",
  
  
  
  
"post_id": "string",
  
  
  
  
"score": "string",
  
  
  
  
"status": "string",
  
  
  
  
"type": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"user_id": "string",
  
  
  
  
"xprofile": {
  
  
  
  
  
"avatar": "string",
  
  
  
  
  
"badge": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"id": "string",
  
  
  
  
  
"is_verified": 0,
  
  
  
  
  
"last_activity": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
  
"short_description_rendered": "string",
  
  
  
  
  
  
"website": "string"
  
  
  
  
  
},
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
"short_description": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"total_points": 0,
  
  
  
  
  
"updated_at": "string",
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"username": "string"
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation