Log a learner interaction event

curl --request POST \
  --url https://edpire.com/api/v1/submissions/{id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "node_id": "<string>",
  "payload": {}
}
'

{
  "data": {
    "ok": true
  },
  "error": {
    "message": "<string>"
  },
  "meta": {}
}

Submissions

Record Event

Records a structured interaction event for an in-progress submission. Use this to stream telemetry from your player to Edpire for analytics and proctoring.

answer_change — fires each time a learner modifies their answer for a question. Requires question_id. Atomically increments the change_count counter on the answer row so you can see how many times a learner revised each answer.

node_view — learner viewed a specific interactive node within a question. Pass node_id to identify it.

paused / resumed — learner paused or resumed the session (e.g. navigated away and returned).

navigated — learner moved between questions or sections. Use the payload field to record { from: questionId, to: questionId }.

flagged — learner flagged a question for review.

POST

submissions

{id}

events

Log a learner interaction event

curl --request POST \
  --url https://edpire.com/api/v1/submissions/{id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "node_id": "<string>",
  "payload": {}
}
'

{
  "data": {
    "ok": true
  },
  "error": {
    "message": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization

string

header

required

API key starting with edp_live_. Pass via Authorization: Bearer edp_live_xxx.

Scopes: read:assessments, write:assessments, read:results, write:submissions.

Path Parameters

string<uuid>

required

Submission ID (must be in_progress)

Body

application/json

event_type

enum<string>

required

Type of interaction event

Available options:

answer_change,

node_view,

paused,

resumed,

navigated,

flagged

question_id

string<uuid>

Required for answer_change events; identifies the answer row to increment

node_id

string

Specific interactive node within the question (e.g. a drag-drop slot ID)

payload

object

Arbitrary event-specific data (e.g. { from, to } for navigated events)

Response

Event recorded

data

object

Show child attributes

error

object

Show child attributes