Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics42

Annotations9

Apps34

Batches4

Bucket Batches23

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters10

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications13

Onboarding2

Ops1

Organization API Keys5

Organization Audit5

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations4

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Learned Fusion10

Retriever Stages1

Retrievers15

Scaffold Templates3

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates24

Triggers10

Webhooks5

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"
    }
  ]
}

Changes

Changed in 4 of the 34 revisions of this API.1012

Aug 23, 20265307993e44d310See the full diff
- ●
  added the new add_to_project enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new add_to_project enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new download enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new download enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new play enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new play enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new rating enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new rating enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new save enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new save enum value to the /// response property for the response status
  response-property-enum-value-added
Aug 9, 20265d4c905106b41See the full diff
- ○
  the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API
  api-security-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 2, 202672cc17ba6f7f2See the full diff
- ○
  added the new optional query request parameter after
  new-optional-request-parameter
- ○
  added the new optional query request parameter next_cursor
  new-optional-request-parameter
Jul 26, 20267cb0515333119See the full diff
- ○
  added the new geo_bounding_box enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history