Skip to main content
Get started

Public REST/JSON reference

Quiz & Assessment Auto-Grader API

Public BFF API for quiz creation, response grading, feedback export, and learner performance analytics. Part of the Logic Igniter Education Suite.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/quizgrader.json

Operations rendered

15

Response models rendered

22

GET/api/v1/quizgrader/customers

List QuizGrader customers

List customers for the QuizGrader service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderCustomersResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/customers

Create QuizGrader customer

Create a customer for the QuizGrader service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: QuizgraderCreateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201QuizgraderCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/customers/{id}

Get QuizGrader customer

Get a customer for the QuizGrader service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

PUT/api/v1/quizgrader/customers/{id}

Update QuizGrader customer

Update a customer for the QuizGrader service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request body (required)

Schema: QuizgraderUpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/quizgrader/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200QuizgraderCustomer

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/quizzes

Get Quizzes

Get Quizzes for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/quizzes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderQuizzesResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/quizzes

Create or run Quizzes

Create or run Quizzes for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: QuizgraderResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/quizzes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201QuizgraderQuiz

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/quizzes/{id}

Get Quizzes/Id

Get Quizzes/Id for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/quizzes/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderQuizDetail

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/responses

Create or run Responses

Create or run Responses for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: QuizgraderResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/responses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201QuizgraderGradeResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/batch

Create or run Batch

Create or run Batch for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: QuizgraderResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/batch" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200QuizgraderBatchResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/grades/{id}

Get Grades/Id

Get Grades/Id for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/grades/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderGradeDetail

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/grades

Get Grades

Get Grades for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/grades" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderGradesResponse

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/export/grades

Create or run Export/Grades

Create or run Export/Grades for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request body (required)

Schema: QuizgraderResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/export/grades" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200QuizgraderExportResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

POST/api/v1/quizgrader/export/feedback

Create or run Export/Feedback

Create or run Export/Feedback for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: QuizgraderResultRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/quizgrader/export/feedback" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200QuizgraderExportResult

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/analytics

Get Analytics

Get Analytics for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderAnalytics

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

GET/api/v1/quizgrader/students/{id}/performance

Get Students/Id/Performance

Get Students/Id/Performance for quiz creation, response grading, feedback export, and learner performance analytics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/quizgrader/students/:id/performance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200QuizgraderStudentPerformance

Successful response

400ErrorResponse

Request validation failed

401ErrorResponse

Missing or invalid bearer token

402ErrorResponse

Subscription or bundle access required

404ErrorResponse

Requested record was not found

500ErrorResponse

Unexpected service error

Data models

QuizgraderResultRequest

FieldTypeNotes
source_idrequiredstring
workspace_idstring
notesstring
filtersobject

QuizgraderResult

FieldTypeNotes
idrequiredstringExample: "rec_1042"
workspace_idstringExample: "workspace_123"
statusrequiredenum(pending | active | completed | failed)One of: pending, active, completed, failed
summaryrequiredstring
scorenumber (double)
signalsarray<string>
created_atstring (date-time)
updated_atstring (date-time)

QuizgraderResultResponse

FieldTypeNotes
datarequiredQuizgraderResult
itemsarray<QuizgraderResult>
next_page_tokenstring

ErrorResponse

FieldTypeNotes
coderequiredstring
messagerequiredstring
request_idstring

QuizgraderQuestion

FieldTypeNotes
idrequiredstring
typerequiredenum(QUESTION_TYPE_UNSPECIFIED | QUESTION_TYPE_MULTIPLE_CHOICE | QUESTION_TYPE_ESSAY)One of: QUESTION_TYPE_UNSPECIFIED, QUESTION_TYPE_MULTIPLE_CHOICE, QUESTION_TYPE_ESSAY
textrequiredstring
pointsrequiredinteger (int32)

QuizgraderQuizDetail

FieldTypeNotes
idrequiredstring
titlerequiredstring
pass_threshold_pctrequirednumber (double)
questionsrequiredarray<QuizgraderQuestion>

QuizgraderQuestionGrade

FieldTypeNotes
question_idrequiredstring
scorerequiredinteger (int32)
max_scorerequiredinteger (int32)
feedbackrequiredstring

QuizgraderGradeDetail

FieldTypeNotes
idrequiredstring
quiz_idrequiredstring
student_idrequiredstring
total_scorerequiredinteger (int32)
max_scorerequiredinteger (int32)
passedrequiredboolean
questionsrequiredarray<QuizgraderQuestionGrade>
submitted_atstring (date-time)

QuizgraderGradesResponse

FieldTypeNotes
itemsrequiredarray<QuizgraderGradeDetail>
next_page_tokenrequiredstring
total_countrequiredinteger (int32)

QuizgraderQuiz

FieldTypeNotes
idstring
titlestring
course_idstring
question_countinteger (int32)

QuizgraderQuizzesResponse

FieldTypeNotes
itemsrequiredarray<QuizgraderQuiz>
next_page_tokenrequiredstring
total_countrequiredinteger (int32)

QuizgraderGradeResult

FieldTypeNotes
idstring
total_scoreinteger (int32)
max_scoreinteger (int32)
passedboolean

QuizgraderBatchResult

FieldTypeNotes
idstring
graded_countinteger (int32)

QuizgraderExportResult

FieldTypeNotes
idrequiredstring
formatrequiredstring
contentrequiredstring (byte)

QuizgraderQuestionDifficulty

FieldTypeNotes
question_idstring
difficultynumber (double)

QuizgraderScoreBucket

FieldTypeNotes
rangestring
countinteger (int32)

QuizgraderAnalytics

FieldTypeNotes
idstring
quiz_idstring
avg_scorenumber (double)
pass_ratenumber (double)
question_difficultiesarray<QuizgraderQuestionDifficulty>
score_distributionarray<QuizgraderScoreBucket>

QuizgraderStudentPerformance

FieldTypeNotes
idstring
student_idstring
avg_scorenumber (double)
quizzes_takeninteger (int32)
pass_ratenumber (double)

QuizgraderCustomer

FieldTypeNotes
idrequiredstring
emailrequiredstring
namerequiredstring
planrequiredenum(PLAN_TIER_UNSPECIFIED | PLAN_TIER_STARTER | PLAN_TIER_GROWTH | PLAN_TIER_PRO | PLAN_TIER_ENTERPRISE | PLAN_TIER_SCALE)One of: PLAN_TIER_UNSPECIFIED, PLAN_TIER_STARTER, PLAN_TIER_GROWTH, PLAN_TIER_PRO, PLAN_TIER_ENTERPRISE, PLAN_TIER_SCALE
statusrequiredenum(CUSTOMER_STATUS_UNSPECIFIED | CUSTOMER_STATUS_ACTIVE | CUSTOMER_STATUS_INACTIVE | CUSTOMER_STATUS_SUSPENDED | CUSTOMER_STATUS_CANCELLED | CUSTOMER_STATUS_TRIAL | CUSTOMER_STATUS_PENDING | CUSTOMER_STATUS_PAUSED)One of: CUSTOMER_STATUS_UNSPECIFIED, CUSTOMER_STATUS_ACTIVE, CUSTOMER_STATUS_INACTIVE, CUSTOMER_STATUS_SUSPENDED, CUSTOMER_STATUS_CANCELLED, CUSTOMER_STATUS_TRIAL, CUSTOMER_STATUS_PENDING, CUSTOMER_STATUS_PAUSED
stripe_customer_idrequiredstring
max_targetsrequiredinteger
created_atstring (date-time)
updated_atstring (date-time)

QuizgraderCustomersResponse

FieldTypeNotes
customersrequiredarray<QuizgraderCustomer>
next_page_tokenrequiredstring
total_countrequiredinteger

QuizgraderCreateCustomerRequest

FieldTypeNotes
emailstring
namestring
planenum(0 | 1 | 2 | 3 | 4 | 5)One of: 0, 1, 2, 3, 4, 5

QuizgraderUpdateCustomerRequest

FieldTypeNotes
namestring
planenum(0 | 1 | 2 | 3 | 4 | 5)One of: 0, 1, 2, 3, 4, 5
statusenum(0 | 1 | 2 | 3 | 4 | 5 | 6 | 7)One of: 0, 1, 2, 3, 4, 5, 6, 7