Skip to main content
GET
Get quiz report

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"

track_id
string

Filter results to participants from a specific track (workflow). When specified, only participants who received the quiz via this track will be included.

Example:

"wf_abc123"

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"

include_feedback
enum<string>
default:false

Include feedback responses from post-quiz surveys (default false)

Available options:
true,
false
Example:

"false"

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)