Request for listing interactions with filters. Supports both simple field filters (for common queries) and advanced LogicalOperator filters (for complex analytics). This hybrid approach follows the same pattern as the Tasks module. Common Queries (Simple Fields): - Filter by execution: {"execution_id": "exec_abc"} - Filter by session: {"session_id": "sess_xyz"} - Filter by user: {"user_id": "user_123"} Advanced Queries (LogicalOperator): - Range queries: {"filters": {"position": {"lte": 5}}} - Complex logic: {"filters": {"AND": [...]}} - Time ranges: {"filters": {"created_at": {"gte": "2025-01-01"}}}
| Name | Type | Description | Notes |
|---|---|---|---|
| execution_id | str | Filter by retriever execution ID. Most common query: find all interactions from a specific search execution. Example: 'exec_abc123' | [optional] |
| retriever_id | str | Filter by retriever ID. Compare performance across different retriever configurations. Example: 'ret_product_search_v2' | [optional] |
| session_id | str | Filter by session ID. Track user journey across multiple searches within a session. Example: 'sess_xyz789' | [optional] |
| user_id | str | Filter by user ID. Analyze behavior of specific users for personalization insights. Example: 'user_456' | [optional] |
| feature_id | str | Filter by feature/document ID. Find all interactions with a specific document across all searches. Example: 'doc_abc123' | [optional] |
| interaction_type | str | Filter by interaction type. Use to find specific behaviors like clicks, purchases, or feedback. Example: 'click', 'positive_feedback' | [optional] |
| filters | LogicalOperatorInput | Advanced filters using LogicalOperator for complex analytics queries. Supports shorthand syntax and complex AND/OR/NOT logic. Use this for: range queries, complex conditions, metadata filtering. Examples: - Position range: {'position': {'lte': 5}} - Time range: {'timestamp': {'gte': '2025-01-01'}} - Complex: {'AND': [{'field': 'position', 'operator': 'lte', 'value': 5}, {'field': 'interaction_type', 'operator': 'in', 'value': ['click', 'purchase']}]} See LogicalOperator documentation for full syntax. | [optional] |
| sort | SortOption | Sort options for ordering results. Default: timestamp descending (newest first). Examples: - Sort by timestamp: {'field': 'timestamp', 'direction': 'desc'} - Sort by position: {'field': 'position', 'direction': 'asc'} | [optional] |
| search | str | Full-text search across metadata fields. NOT REQUIRED. Use to search interaction metadata content. | [optional] |
from mixpeek.models.list_interactions_request import ListInteractionsRequest
# TODO update the JSON string below
json = "{}"
# create an instance of ListInteractionsRequest from a JSON string
list_interactions_request_instance = ListInteractionsRequest.from_json(json)
# print the JSON string representation of the object
print(ListInteractionsRequest.to_json())
# convert the object into a dict
list_interactions_request_dict = list_interactions_request_instance.to_dict()
# create an instance of ListInteractionsRequest from a dict
list_interactions_request_from_dict = ListInteractionsRequest.from_dict(list_interactions_request_dict)