Skip to content

Generate Answers CSV

Request the generation of a CSV export containing all quiz responses.


Overview

This endpoint initiates an asynchronous process to export all quiz answers to a CSV file. The export is queued for processing and will be made available once complete.

Method: POST
Endpoint:
/api/v1/namespaces/:namespaceId/quizzes/:quizId/csvExport

Requires administrative authentication.


Request

Headers

http
x-api-key: {your_api_key}  # Required
Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
namespaceIdstringNamespace unique ID
quizIdstringQuiz unique ID

Body

The request body may optionally include:

json
{
  "invitedUserId": "user123"  # Optional
}

Response

json
{
  "queued": true
}

The response indicates that the export process has been queued successfully. The actual CSV file will be generated asynchronously.


Error Responses

  • 500 Internal Server Error – If the namespace or quiz does not exist
json
{
  "error": "namespace does not exist"
}
json
{
  "error": "quiz does not exist"
}

Authorization Requirements

This endpoint requires authentication with one of the following permissions:

  • System administrator
  • Namespace administrator
  • Demo mode access