GETTING STARTED
SearchAssist Overview
SearchAssist Introduction
Onboarding SearchAssist
Build your first App
Glossary
Release Notes
What's new in SearchAssist
Previous Versions

CONCEPTS
Managing Sources
Introduction
Files
Web Pages
FAQs
Structured Data 
Connectors
Introduction to Connectors
Azure Storage Connector
Confluence Cloud Connector
Confluence Server Connector
Custom Connector
DotCMS Connector
Dropbox Connector
Google Drive Connector
Oracle Knowledge Connector
Salesforce Connector
ServiceNow Connector
SharePoint Connector
Zendesk Connector
RACL
Virtual Assistants
Managing Indices
Introduction
Index Fields
Traits
Workbench
Introduction to Workbench
Field Mapping
Entity Extraction
Traits Extraction
Keyword Extraction
Exclude Document
Semantic Meaning
Snippet Extraction
Custom LLM Prompts
Index Settings
Index Languages
Managing Chunks
Chunk Browser
Managing Relevance
Introduction
Weights
Highlighting
Presentable
Synonyms
Stop Words
Search Relevance
Spell Correction
Prefix Search
Custom Configurations
Personalizing Results
Introduction
Answer Snippets
Introduction
Extractive Model
Generative Model
Enabling Both Models
Simulation and Testing
Debugging
Best Practices and Points to Remember
Troubleshooting Answers
Answer Snippets Support Across Content Sources
Result Ranking
Facets
Business Rules
Introduction
Contextual Rules
NLP Rules
Engagement
Small Talk
Bot Actions
Designing Search Experience
Introduction
Search Interface
Result Templates
Testing
Preview and Test
Debug Tool
Running Experiments
Introduction
Experiments
Analyzing Search Performance
Overview
Dashboard
User Engagement
Search Insights
Result Insights
Answer Insights

ADMINISTRATION
General Settings
Credentials
Channels
Team
Collaboration
Integrations
OpenAI Integration
Azure OpenAI Integration
Custom Integration
Billing and Usage
Plan Details
Usage Logs
Order and Invoices
Smart Hibernation

SearchAssist APIs
API Introduction
API List

SearchAssist SDK

HOW TOs
Use Custom Fields to Filter Search Results and Answers
Add Custom Metadata to Ingested Content
Write Painless Scripts
Configure Business Rules for Generative Answers

History API

This API fetches the search results and answers corresponding to all the searches performed by a given user in the SearchAssist application. 

Method POST
Endpoint <host_url>/searchassistapi/external/stream/<streamId>/history
Content-Type application/json
Auth <JWT Token>
API Scope     Analytics
Rate Limit 200 requests per application per hour

Query Parameters

Parameters Description Mandatory
streamId Provide your application ID here.  Yes
skip This is an optional field that refers to the number of initial records to skip from the result.  No
limit This optional parameter refers to the number of records to be included in the result. This is used for pagination. The maximum value of the limit can be 200. The default pagination limit is 20. No

Request Parameters

Parameters Description Mandatory
clientId Unique client Id for the application Yes
userIdentity Unique user Id for the user whose history is to be fetched.  Yes

Sample Request

{
  "userConfig": {
    "clientId": "cs-***",
    "userIdentity": "u-4e0c8e48-0126-51bb-bb74-********"
  }
}

Response Format

{
   "history": [
       {},
       {}
   ],
   "templateSettingVersions": [
       {}
   ],
   "hasMore": <true/false>,
   "total": <number of records
}

History API

This API fetches the search results and answers corresponding to all the searches performed by a given user in the SearchAssist application. 

Method POST
Endpoint <host_url>/searchassistapi/external/stream/<streamId>/history
Content-Type application/json
Auth <JWT Token>
API Scope     Analytics
Rate Limit 200 requests per application per hour

Query Parameters

Parameters Description Mandatory
streamId Provide your application ID here.  Yes
skip This is an optional field that refers to the number of initial records to skip from the result.  No
limit This optional parameter refers to the number of records to be included in the result. This is used for pagination. The maximum value of the limit can be 200. The default pagination limit is 20. No

Request Parameters

Parameters Description Mandatory
clientId Unique client Id for the application Yes
userIdentity Unique user Id for the user whose history is to be fetched.  Yes

Sample Request

{
  "userConfig": {
    "clientId": "cs-***",
    "userIdentity": "u-4e0c8e48-0126-51bb-bb74-********"
  }
}

Response Format

{
   "history": [
       {},
       {}
   ],
   "templateSettingVersions": [
       {}
   ],
   "hasMore": <true/false>,
   "total": <number of records
}