Public Retriever API

Track Interaction Batch

Changed on

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

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/public/retrievers/{public_name}/interactions/batch
  • Auth: none required

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

unknown required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5307993e44d3Revision changes
    • info

      added the new add_to_project enum value to the request property ///

    • info

      added the new download enum value to the request property ///

    • info

      added the new play enum value to the request property ///

    • info

      added the new rating enum value to the request property ///

    • info

      added the new save enum value to the request property ///