Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Retriever Interactions

List Interactions

List interactions with optional filters and pagination.

Supports hybrid filtering: simple fields + advanced LogicalOperator.

post/v1/retrievers/interactions/list

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

execution_idstring nullable

Filter by retriever execution ID. Most common query: find all interactions from a specific search execution. Example: 'exec_abc123'

retriever_idstring nullable

Filter by retriever ID. Compare performance across different retriever configurations. Example: 'ret_product_search_v2'

session_idstring nullable

Filter by session ID. Track user journey across multiple searches within a session. Example: 'sess_xyz789'

user_idstring nullable

Filter by user ID. Analyze behavior of specific users for personalization insights. Example: 'user_456'

feature_idstring nullable

Filter by feature/document ID. Find all interactions with a specific document across all searches. Example: 'doc_abc123'

interaction_typestring nullable

Filter by interaction type. Use to find specific behaviors like clicks, purchases, or feedback. Example: 'click', 'positive_feedback'

searchstring nullable

Full-text search across metadata fields. NOT REQUIRED. Use to search interaction metadata content.

Example request

{
  "execution_id": "exec_abc123",
  "retriever_id": "ret_product_search",
  "session_id": "sess_abc123",
  "user_id": "user_abc123",
  "feature_id": "doc_abc123",
  "interaction_type": "click",
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at"
  },
  "search": "mobile device"
}

Response

Successful Response

Example response

{
  "results": [
    {
      "description": "Minimal click interaction (query_snapshot and document_score optional)",
      "execution_id": "exec_minimal_123",
      "feature_id": "doc_abc123",
      "interaction_type": [
        "click"
      ],
      "position": 2,
      "session_id": "sess_minimal"
    }
  ],
  "items": [
    {
      "description": "Minimal click interaction (query_snapshot and document_score optional)",
      "execution_id": "exec_minimal_123",
      "feature_id": "doc_abc123",
      "interaction_type": [
        "click"
      ],
      "position": 2,
      "session_id": "sess_minimal"
    }
  ]
}