v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

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/v1/public/retrievers/{public_name}/interactions/batch

Path parameters

public_namestring required

Public name of the published retriever

Headers

X-Session-IDstring nullable

X-Public-API-Keystring nullable

Request body

Example request

{
  "interactions": [
    {
      "document_id": "doc_abc123",
      "interaction_type": [
        "click"
      ],
      "execution_id": "exec_abc123xyz",
      "query_snapshot": {
        "text": "wireless headphones"
      },
      "document_score": 0.95,
      "result_set_size": 10,
      "session_id": "sess_abc123"
    }
  ]
}

Response

Successful Response

{"stackTrail":"paths:/v1/public/retrievers/{public_name}/interactions/batch:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}