QuizzQ
Endpoints

API Endpoints

Explore the available API endpoints and their usage

Quiz Management

Create and manage quizzes

GET
/v1/quizzes

List all quizzes

Example Request

curl https://api.quizzq.com/v1/quizzes \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "quizzes": [ { "id": "quiz_123", "title": "Math Quiz", "questions": 10 } ] }
POST
/v1/quizzes

Create a new quiz

Example Request

curl -X POST https://api.quizzq.com/v1/quizzes \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Science Quiz", "description": "Test your knowledge" }'

Example Response

{ "id": "quiz_124", "title": "Science Quiz", "created_at": "2025-01-13T17:54:56Z" }

User Operations

Manage users and permissions

GET
/v1/users

List all users

Example Request

curl https://api.quizzq.com/v1/users \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "users": [ { "id": "user_123", "name": "John Doe", "role": "student" } ] }
POST
/v1/users

Create a new user

Example Request

curl -X POST https://api.quizzq.com/v1/users \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Jane Smith", "email": "jane@example.com" }'

Example Response

{ "id": "user_124", "name": "Jane Smith", "created_at": "2025-01-13T17:54:56Z" }

Grading

Grade management and analytics

POST
/v1/submissions/{id}/grade

Grade a quiz submission

Example Request

curl -X POST https://api.quizzq.com/v1/submissions/sub_123/grade \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "submission_id": "sub_123", "score": 85, "feedback": "Great work!" }
GET
/v1/submissions/{id}/results

Get submission results

Example Request

curl https://api.quizzq.com/v1/submissions/sub_123/results \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "submission_id": "sub_123", "score": 85, "answers": [...] }

Analytics

Performance and usage analytics

GET
/v1/analytics/quiz/{id}

Get quiz analytics

Example Request

curl https://api.quizzq.com/v1/analytics/quiz/quiz_123 \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "quiz_id": "quiz_123", "total_attempts": 150, "avg_score": 78.5 }
GET
/v1/analytics/user/{id}

Get user analytics

Example Request

curl https://api.quizzq.com/v1/analytics/user/user_123 \ -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{ "user_id": "user_123", "quizzes_taken": 25, "avg_score": 82.3 }

Response Codes

Success Codes

  • 200OK - Request successful
  • 201Created - Resource created
  • 204No Content - Request successful

Error Codes

  • 400Bad Request - Invalid input
  • 401Unauthorized - Invalid credentials
  • 404Not Found - Resource not found
  • 429Too Many Requests - Rate limit exceeded