Skip to main content
GET
/
v1
/
quizzes
/
{quizId}
/
report
Get quiz report
curl --request GET \
  --url https://api.doozy.live/v1/quizzes/{quizId}/report \
  --header 'x-api-key: <api-key>'
{
  "object": "quiz_report",
  "id": "quiz_abc123",
  "title": "Product Knowledge Assessment",
  "summary": {
    "total_participants": 145,
    "completed": 120,
    "in_progress": 10,
    "not_started": 10,
    "expired": 5,
    "average_score": 78.5,
    "completion_rate": 82.8
  },
  "participants": [
    {
      "object": "quiz_participant",
      "id": "user_abc123",
      "email": "jane.doe@example.com",
      "display_name": "Jane Doe",
      "slack_user_id": "U01234567",
      "group_name": "Engineering",
      "manager_email": "manager@example.com",
      "manager_name": "John Smith",
      "manager_slack_user_id": "U09876543",
      "status": "completed",
      "score": 85,
      "total_questions": 10,
      "answered_questions": 10,
      "correct_answers": 8,
      "incorrect_answers": 2,
      "assigned_at": "2026-01-15T10:30:00.000Z",
      "completed_at": "2026-01-15T11:00:00.000Z",
      "delivery_method": "track",
      "track_id": "trk_xyz789",
      "track_name": "Onboarding Quiz",
      "is_admin": false,
      "question_responses": [
        {
          "object": "question_response",
          "question_id": "q_abc123",
          "submitted_answer": {
            "id": "<string>",
            "answer": "<string>"
          },
          "is_correct": true,
          "answered_at": "2026-02-01T14:22:00.000Z"
        }
      ]
    }
  ],
  "delivery_instances": [
    {
      "object": "quiz_delivery_instance",
      "id": "inst_abc123",
      "total_participants": 25,
      "delivery_method": "track",
      "track_id": "trk_xyz789",
      "track_name": "Onboarding Quiz",
      "delivery_detail": "#general channel"
    }
  ],
  "has_more": true,
  "url": "/v1/quizzes/quiz_abc123/report",
  "next_cursor": "resp_xyz789",
  "previous_cursor": "resp_abc123",
  "question_analytics": [
    {
      "object": "question_analytics",
      "id": "q_abc123",
      "question": "What is the capital of France?",
      "type": "multipleChoice",
      "round_id": "round_xyz789",
      "round_name": "Geography",
      "total_answered": 120,
      "total_correct": 95,
      "total_incorrect": 25,
      "accuracy_rate": 79.2,
      "answer_breakdown": [
        {
          "id": "ans_a1b2c3",
          "answer": "Paris",
          "total_selected": 45,
          "correct_selections": 45,
          "incorrect_selections": 0
        }
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Path Parameters

​
quizId
string
required

The unique identifier of the quiz

Minimum string length: 1
Example:

"quiz_abc123"

Query Parameters

​
limit
integer
default:25

Maximum number of participants to return (1-100, default 25)

Required range: 1 <= x <= 100
Example:

25

​
starting_after
string

Cursor for pagination - the user ID of the last participant from the previous page

Example:

"user_abc123"

​
ending_before
string

Cursor for backward pagination - the user ID of the first participant on the previous page

Example:

"user_xyz789"

​
status
enum<string>

Filter participants by status

Available options:
not_started,
in_progress,
completed,
expired
Example:

"completed"

​
include_collaborators
enum<string>
default:false

Include quiz admin users in results (default false)

Available options:
true,
false
Example:

"false"

​
include_question_responses
enum<string>
default:false

Include per-question responses for each participant (default false)

Available options:
true,
false
Example:

"true"

​
include_question_analytics
enum<string>
default:false

Include per-question analytics with answer breakdowns (default false)

Available options:
true,
false
Example:

"true"

Response

Quiz report with participants and analytics

​
object
enum<string>
required

Object type identifier

Available options:
quiz_report
Example:

"quiz_report"

​
id
string
required

Quiz ID

Example:

"quiz_abc123"

​
title
string
required

Quiz title

Example:

"Product Knowledge Assessment"

​
summary
object
required

Summary statistics for the report

​
participants
object[]
required

Paginated list of participants

​
delivery_instances
object[]
required

Quiz delivery instances (workflows and one-off sends)

​
has_more
boolean
required

Whether there are more participants available beyond this page

Example:

true

​
url
string
required

The URL for accessing this report

Example:

"/v1/quizzes/quiz_abc123/report"

​
next_cursor
string | null
required

Cursor to fetch the next page of participants. Pass as starting_after in subsequent requests.

Example:

"resp_xyz789"

​
previous_cursor
string | null
required

Cursor to fetch the previous page of participants. Pass as ending_before in subsequent requests.

Example:

"resp_abc123"

​
question_analytics
object[]

Per-question analytics (only included if include_question_analytics=true)