Quizzes API

Route: /api/groups/quizzes

Documentation for the quizzes API endpoint will be added here.

Quizzes Analytics API

Route: POST /api/groups/quizzes

Get analytics data for quiz usage by students within a group, including quizzes created, questions made, and questions answered with optional student-level breakdowns.

Authentication

This endpoint requires authentication using an API key. Header Required:

x-api-key: YOUR_API_KEY

Parameters

Query Parameters

Parameter	Type	Required	Default	Description
`startDate`	string	No	`2025-01-01T00:00:00.000Z`	Start date for analytics period (ISO 8601 format)
`endDate`	string	No	Current date	End date for analytics period (ISO 8601 format)
`students`	boolean	No	`false`	Whether to return student-level data (`true`) or group-level data (`false`)

Response Format

Group-Level Data (students=false)

Returns aggregated quiz analytics for the entire group.

{
  "success": true,
  "reports": [
    {
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-07T23:59:59.999Z",
      "numStudentsUsed": 25,
      "data": [
        {
          "title": "Quizzes Made",
          "value": 34
        },
        {
          "title": "Questions Made",
          "value": 287
        },
        {
          "title": "Questions Answered",
          "value": 1456
        }
      ]
    }
  ]
}

Student-Level Data (students=true)

Returns individual student quiz analytics.

{
  "success": true,
  "reports": [
    {
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-07T23:59:59.999Z",
      "studentName": "John Doe",
      "studentId": "user_123456",
      "data": [
        {
          "title": "Quizzes Made",
          "value": 2
        },
        {
          "title": "Questions Made",
          "value": 18
        },
        {
          "title": "Questions Answered",
          "value": 73
        }
      ]
    }
  ]
}

Data Fields Explained

Quiz Metrics

Quizzes Made: Number of quizzes created by students
Questions Made: Total number of quiz questions created
Questions Answered: Number of quiz questions answered by students

Additional Fields

numStudentsUsed (Group-level only): Number of unique students who used quiz features
studentName (Student-level only): Display name of the student
studentId (Student-level only): Unique identifier for the student

Error Responses

403 Unauthorized

Returned when API key is missing or invalid.

{
  "error": "Unauthorized"
}

Causes:

Missing x-api-key header
Invalid API key
API key not associated with a valid group plan

400 Bad Request

Returned when required parameters are missing.

{
  "error": "Missing params"
}

Notes

Reports are automatically sorted by start date in ascending order
Date ranges are inclusive of both start and end dates
All timestamps should be in ISO 8601 format

​Quizzes API

​Quizzes Analytics API

​Authentication

​Parameters

​Query Parameters

​Response Format

​Group-Level Data (students=false)

​Student-Level Data (students=true)

​Data Fields Explained

​Quiz Metrics

​Additional Fields

​Error Responses

​403 Unauthorized

​400 Bad Request

​Notes