Track Interaction Batch

curl --request POST \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/interactions/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interactions": [
    {
      "document_id": "<string>",
      "interaction_type": [],
      "position": 1,
      "execution_id": "exec_abc123xyz",
      "query_snapshot": {
        "text": "wireless headphones"
      },
      "document_score": 0.95,
      "result_set_size": 10,
      "session_id": "sess_abc123",
      "metadata": {}
    }
  ]
}
'

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Public Retriever API

Track Interaction Batch

Track multiple interactions in a single request (batching).

More efficient than sending individual interaction requests. Use this for batching viewport visibility, bulk actions, etc.

Authentication:

API key is OPTIONAL (same as execute endpoint)
Password NOT required (tracking should work even without auth)

Recommended Headers:

X-Session-ID: Applied to all interactions in the batch

Limits:

Maximum 100 interactions per batch

Example:

curl -X POST "https://api.mixpeek.com/v1/public/retrievers/video-search/interactions/batch" \
  -H "X-Session-ID: sess_xyz..." \
  -H "Content-Type: application/json" \
  -d '{
    "interactions": [
      {
        "document_id": "doc_123",
        "interaction_type": ["VIEW"],
        "position": 0,
        "execution_id": "exec_abc"
      },
      {
        "document_id": "doc_456",
        "interaction_type": ["VIEW"],
        "position": 1,
        "execution_id": "exec_abc"
      }
    ]
  }'

POST

public

retrievers

{public_name}

interactions

batch

Track Interaction Batch

curl --request POST \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/interactions/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interactions": [
    {
      "document_id": "<string>",
      "interaction_type": [],
      "position": 1,
      "execution_id": "exec_abc123xyz",
      "query_snapshot": {
        "text": "wireless headphones"
      },
      "document_score": 0.95,
      "result_set_size": 10,
      "session_id": "sess_abc123",
      "metadata": {}
    }
  ]
}
'

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Session-ID

string | null

X-Public-API-Key

string | null

Path Parameters

public_name

string

required

Public name of the published retriever

Body

application/json

Request to track multiple interactions in batch.

interactions

PublicInteractionRequest · object[]

required

List of interactions to track (max 100 per batch)

Required array length: 1 - 100 elements

Show child attributes

Response

Successful Response

Track Interaction Create Taxonomy