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