GET
/
v1
/
retrievers
/
interactions
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/interactions
[
  {
    "feature_id": "prod_123",
    "interaction_type": [
      "positive_feedback",
      "click",
      "long_view"
    ],
    "position": 3,
    "metadata": {
      "device": "mobile",
      "duration_ms": 5000,
      "interaction_reason": "not_relevant",
      "page": "search_results",
      "page_number": 1,
      "results_count": 50,
      "search_latency_ms": 150,
      "viewport_position": 0.75
    },
    "user_id": "customer_user_456",
    "session_id": "sess_abc123",
    "interaction_id": "int_xyz789"
  }
]

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Query Parameters

​
feature_id
string | null
​
interaction_type
string | null
​
session_id
string | null
​
page
integer | null
default:1
​
page_size
integer
default:10

Response

200
application/json
Successful Response
​
feature_id
string
required

ID of the item that was interacted with

Example:

"prod_123"

​
interaction_type
enum<string>[]
required

Type of interaction or feedback

Available options:
view,
click,
positive_feedback,
negative_feedback,
purchase,
add_to_cart,
wishlist,
long_view,
share,
bookmark,
query_refinement,
zero_results,
filter_toggle,
skip,
return_to_results
Example:
["positive_feedback", "click", "long_view"]
​
interaction_id
string
required

Unique identifier for this interaction

Example:

"int_xyz789"

​
position
integer | null

Position in search results where interaction occurred

Example:

3

​
metadata
object | null

Additional context about the interaction

Example:
{
  "device": "mobile",
  "duration_ms": 5000,
  "interaction_reason": "not_relevant",
  "page": "search_results",
  "page_number": 1,
  "results_count": 50,
  "search_latency_ms": 150,
  "viewport_position": 0.75
}
​
user_id
string | null

Customer's authenticated user identifier - persists across sessions

Example:

"customer_user_456"

​
session_id
string | null

Temporary identifier for a single search journey/session (typically 30min-1hr) - tracks anonymous and authenticated users

Example:

"sess_abc123"

Was this page helpful?

Suggest editsRaise issue