This API enables XO v10 SmartAssist users to access Agent AI specific reporting, which was previously unavailable. Learn more.
Method | GET |
Endpoint | https:/{{host}}/agentassist/api/v1/public/{{streamid}}/v2/agentassistinteractions?from=YYYY-MM-DD&to=YYYY-MM-DD |
Content-Type | application/json |
Authorization | auth: {{JWT}}
|
API Scope | AgentAssist Analytics |
Path Parameters
PARAMETER | REQUIRED/OPTIONAL | DESCRIPTION |
host | Required | Environment URL |
streamid | Required | Current bot |
Query Parameters
PARAMETER | REQUIRED/OPTIONAL | DESCRIPTION |
from | Required | Specifies the start date for the time range of AgentAssist interactions in YYYY-MM-DD format. |
to | Required | Specifies the end date for the time range of AgentAssist interactions in YYYY-MM-DD format. |
Sample Request
curl --location 'https://smartassist.kore.ai/agentassist/api/v1/public/st-1d0d8e27-930f-58ea-9e8e-3bd406xxxxxx/v2/agentassistinteractions?from=2024-11-03&to=2024-11-03' \ --header 'accountId: 64ec80d542873c0cddaxxxxx' \ --header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLTgwNDM3ZjRkLTdhZmYtNWQ4Ni1hNDkzLTRiOTMwMDM2MWEyZiJ9.oqzN3DCKQBOuJWmarw7-6c-8XzsNRK43rQX90kxxxxx'
Headers
- accountId (required): The account ID associated with the API request.
- auth (required): JWT token for authentication.
Sample Response
{ "numResults": 2, "data": [ { "conversationID": "c-c0dd719-5850-4dcc-b702-c77888xxxxxx", "botSessionID": "67275abf4f7188e977xxxxxx", "channel": "chat", "segmentID": "ac-9be25b1-86cd-488d-830a-a80350xxxxxx", "segmentStartTime": "2024-11-03T11:13:29.156Z", "segmentEndTime": "2024-11-03T11:19:12.208Z", "queueInfo": { "queueId": "qu-558c03b-1616-4e6c-9a58-60ed35xxxxxx", "queueName": "Default Queue" }, "agent": { "agentName": "Anand C", "agentId": "u-058f5448-e74b-5981-a74d-20858cxxxxxx" }, "tags": [], "agentActions": [ { "actionType": "SearchBarEntry", "action": { "searchPhrase": "syntax", "typingStartTime": "2024-11-03T11:18:09.905Z", "executionStartTime": "2024-11-03T11:18:12.600Z", "displayTime": "2024-11-03T11:18:15.143Z", "countDisplayedAnswers": { "countDialogTasks": 1, "countFaqs": 0, "countWebPages": 0, "countFiles": 0, "countAnswers": 1, "countFromNonNativeDataSource": 0 }, "suggestions": { "dialogs": [ { "name": "syntax" } ], "answers": [ { "positionId": "dg-9avex5xxxx", "internalFlag": true, "content": [ { "answer_fragment": "Python's simple syntax makes it an ideal choice for rapid prototyping. Developers can quickly write and test code, without having to worry about complex syntax or verbose code. ", "sources": [ { "title": "Python Answers.pdf", "url": "https://searchassistconnector.blob.core.windows.net/searchcontainer/Python Answers.pdf#page=2", "chunk_id": "chk-028541ee-833e-4175-bcb3-702791xxxxxx", "doc_id": "fc-77230571-17ca-5447-acdd-1b2b1dxxxxxx", "source_id": "fs-e1e7db5a-785d-5554-a6b2-ffef92xxxxxx", "source_type": "azureStorage", "image_url": "" } ] } ], "sources": [ { "title": "", "url": "" } ], "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "positionId": "dg-x0y5fmxxxx", "content": "Python's simple syntax makes it an ideal choice for rapid prototyping. Developers can quickly write and test code, without having to worry about complex syntax or verbose code. ", "sources": [ { "title": "Python Answers.pdf", "url": "https://searchassistconnector.blob.core.windows.net/searchcontainer/Python Answers.pdf#page=2" } ], "internalFlag": false, "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } } ] } }, "used": [ { "targetType": "Answer", "target": { "positionId": "dg-x0y5fmxxxx", "title": "Python's simple syntax makes", "status": "send", "displayTime": "2024-11-03T11:18:19.164Z", "showmoreClicked": false, "internalInfoMoreClicked": false, "answerLinkClicked": [] } } ] }, { "actionType": "SearchBarEntry", "action": { "searchPhrase": "pension", "typingStartTime": "2024-11-03T11:18:32.328Z", "executionStartTime": "2024-11-03T11:18:33.199Z", "displayTime": "2024-11-03T11:18:36.165Z", "countDisplayedAnswers": { "countDialogTasks": 0, "countFaqs": 0, "countWebPages": 8, "countFiles": 0, "countAnswers": 1, "countFromNonNativeDataSource": 0 }, "suggestions": { "answers": [ { "positionId": "dg-czo54dxxxx", "internalFlag": true, "content": [ { "answer_fragment": "An employee must complete a minimum of 10 years in service in order to avail pension through EPS ", "sources": [ { "title": "PF_Presentation.pptx", "url": "https://searchassist-pilot.kore.ai/searchassistapi/getMediaStream/findly/fe-Zi02ODM0YTE1NS04ODEyLTU5MDctODFhNS04NWYzNmQ4ZjcxYTcucHB0eHxlMDg3NzA0ZjcyYzMzY2E1MWY2MGU1MDhhOTE2M2YyMDQyYjU5ZWFiNTk4NDk0Y2I1MWQ5ZTQyOWY2NWFhZDQx?n=8652674254&s=ImpqZDhTL2RwanVyUmgxUVpnOEgxQ2xEd2ZBQUt2NVVwWHd6V0NkUXUzUUU9Ig$$#page=8", "chunk_id": "chk-1f18b7f3-9ff2-4030-95ca-a8ee53xxxxxx", "doc_id": "fc-6a4fc74c-e4c2-527f-8e39-e5d1bexxxxxx", "source_id": "fs-2ebc7c32-f03d-5fd5-b8a2-a23708xxxxxx", "source_type": "file", "image_url": "" } ] }, { "answer_fragment": ". An employee can get a maximum of 3800 Rs per month through the pension scheme ", "sources": [ { "title": "PF_Presentation.pptx", "url": "https://searchassist-pilot.kore.ai/searchassistapi/getMediaStream/findly/fe-Zi02ODM0YTE1NS04ODEyLTU5MDctODFhNS04NWYzNmQ4ZjcxYTcucHB0eHxlMDg3NzA0ZjcyYzMzY2E1MWY2MGU1MDhhOTE2M2YyMDQyYjU5ZWFiNTk4NDk0Y2I1MWQ5ZTQyOWY2NWFhZDQx?n=8652674254&s=ImpqZDhTL2RwanVyUmgxUVpnOEgxQ2xEd2ZBQUt2NVVwWHd6V0NkUXUzUUU9Ig$$#page=8", "chunk_id": "chk-1f18b7f3-9ff2-4030-95ca-a8ee53xxxxxx", "doc_id": "fc-6a4fc74c-e4c2-527f-8e39-e5d1bexxxxxx", "source_id": "fs-2ebc7c32-f03d-5fd5-b8a2-a23708xxxxxx", "source_type": "file", "image_url": "" } ] }, { "answer_fragment": ". After retirement, the pension scheme runs up to his lifetime. Pension received is lifelong and passes on to spouse and two children upon the employee’s death ", "sources": [ { "title": "PF_Presentation.pptx", "url": "https://searchassist-pilot.kore.ai/searchassistapi/getMediaStream/findly/fe-Zi02ODM0YTE1NS04ODEyLTU5MDctODFhNS04NWYzNmQ4ZjcxYTcucHB0eHxlMDg3NzA0ZjcyYzMzY2E1MWY2MGU1MDhhOTE2M2YyMDQyYjU5ZWFiNTk4NDk0Y2I1MWQ5ZTQyOWY2NWFhZDQx?n=8652674254&s=ImpqZDhTL2RwanVyUmgxUVpnOEgxQ2xEd2ZBQUt2NVVwWHd6V0NkUXUzUUU9Ig$$#page=8", "chunk_id": "chk-1f18b7f3-9ff2-4030-95ca-a8ee53xxxxxx", "doc_id": "fc-6a4fc74c-e4c2-527f-8e39-e5d1bexxxxxx", "source_id": "fs-2ebc7c32-f03d-5fd5-b8a2-a23708xxxxxx", "source_type": "file", "image_url": "" } ] }, { "answer_fragment": ". An employee cannot claim the pension scheme if they are having less than or equal to 6 months of service period ", "sources": [ { "title": "PF_Presentation.pptx", "url": "https://searchassist-pilot.kore.ai/searchassistapi/getMediaStream/findly/fe-Zi02ODM0YTE1NS04ODEyLTU5MDctODFhNS04NWYzNmQ4ZjcxYTcucHB0eHxlMDg3NzA0ZjcyYzMzY2E1MWY2MGU1MDhhOTE2M2YyMDQyYjU5ZWFiNTk4NDk0Y2I1MWQ5ZTQyOWY2NWFhZDQx?n=8652674254&s=ImpqZDhTL2RwanVyUmgxUVpnOEgxQ2xEd2ZBQUt2NVVwWHd6V0NkUXUzUUU9Ig$$#page=8", "chunk_id": "chk-1f18b7f3-9ff2-4030-95ca-a8ee53xxxxxx", "doc_id": "fc-6a4fc74c-e4c2-527f-8e39-e5d1bexxxxxx", "source_id": "fs-2ebc7c32-f03d-5fd5-b8a2-a23708xxxxxx", "source_type": "file", "image_url": "" } ] } ], "sources": [ { "title": "", "url": "" } ], "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "positionId": "dg-q2elu58yq3", "content": "An employee must complete a minimum of 10 years in service in order to avail pension through EPS . An employee can get a maximum of 3800 Rs per month through the pension scheme . After retirement, the pension scheme runs up to his lifetime. Pension received is lifelong and passes on to spouse and two children upon the employee’s death . An employee can not claim the pension scheme if they are having less than or equal to 6 months of service period ", "sources": [ { "title": "PF_Presentation.pptx", "url": "https://searchassist-pilot.kore.ai/searchassistapi/getMediaStream/findly/fe-Zi02ODM0YTE1NS04ODEyLTU5MDctODFhNS04NWYzNmQ4ZjcxYTcucHB0eHw0OWQxMzBiNmQyMTYyZTM2OWVlMmY4MWM1N2VmMzg0NTcwNTAzNGM0YjgwMDViYmFmYjM3NzJmYjY3MzE0OTJi?n=8652674254&s=ImpqZDhTL2RwanVyUmgxUVpnOEgxQ2xEd2ZBQUt2NVVwWHd6V0NkUXUzUUU9Ig$$#page=8" } ], "internalFlag": false, "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } } ], "web": [ { "sources": [ { "title": "National Pension Scheme - NPS Scheme, Online Account Opening & Contibution", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fnps-national-pension-scheme&requestId=fsh-059b7ca4-9333-5dd0-b53b-a060dc413355&contentId=fc-05365252-01f6-4361-8067-aa84611cc1d8&hId=0c5fde9a7fb62d61255d46488e632b4254108d6d8f7f3034dc16d95912a723ee" } ], "content": "", "positionId": "dg-narewmt3pe", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "sources": [ { "title": "Paytm Money - Online Demat Account, Trading, Direct Mutual Funds & NPS", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2F&requestId=fsh-059b7ca4-9333-5dd0-b53b-a060dc413355&contentId=fc-d85c516e-617b-4fba-9990-9a8a518daf93&hId=65d0b17e32980e589aeccae31b10d3e80f0bc59cbbe919854e1c857d0f2c430d" } ], "content": "", "positionId": "dg-3s4yxxxxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "sources": [ { "title": "About Paytm Money - Making Investing Simple & Transparent", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fabout-us&requestId=fsh-059b7ca4-9333-5dd0-b53b-a060dc413355&contentId=fc-b965aead-4a87-4179-8ee6-86b26d2d7e6e&hId=571740fa15629513d004203df190953e74e1862e5b7a2802b1e3ed782c944dc9" } ], "content": "", "positionId": "dg-6wh2b9xxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "sources": [ { "title": "Invest In Best Direct Mutual Funds In India | Paytm Money", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fmutual-funds&requestId=fsh-059b7ca4-9333-5dd0-b53b-a060dc413355&contentId=fc-e87b01a6-e421-45aa-a709-370444e5509d&hId=76a7f08fbf4105b978327242fb05120e5107a7adbd2ebcff84dafb24a0b59328" } ], "content": "", "positionId": "dg-zihcxxxxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "sources": [ { "title": "National Pension Scheme - NPS Scheme, Online Account Opening & Contibution", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fnps-national-pension-scheme&requestId=fsh-9d8d5e21-057c-5233-8eaf-eaea6198e3d5&contentId=fc-05365252-01f6-4361-8067-aa84611cc1d8&hId=f02ec2984522290e282b7f5e58ab8416ea06bc8723a6848100aeb3b31bc2dfc0" } ], "content": "", "positionId": "dg-jsz64kxxxx", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } }, { "sources": [ { "title": "Paytm Money - Online Demat Account, Trading, Direct Mutual Funds & NPS", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2F&requestId=fsh-9d8d5e21-057c-5233-8eaf-eaea6198e3d5&contentId=fc-d85c516e-617b-4fba-9990-9a8a518daf93&hId=543d3b040b5c01d96023c130472bed872a10d976680f09ef6f7e71c0b8310f48" } ], "content": "", "positionId": "dg-w2ey91xxxx", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } }, { "sources": [ { "title": "About Paytm Money - Making Investing Simple & Transparent", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fabout-us&requestId=fsh-9d8d5e21-057c-5233-8eaf-eaea6198e3d5&contentId=fc-b965aead-4a87-4179-8ee6-86b26d2d7e6e&hId=fdfb578738bfe33b6adbe8ee2d2c4a3159c6a6f577974051f4df1ae727def43c" } ], "content": "", "positionId": "dg-98acy3xxxxx", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } }, { "sources": [ { "title": "Invest In Best Direct Mutual Funds In India | Paytm Money", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.paytmmoney.com%2Fmutual-funds&requestId=fsh-9d8d5e21-057c-5233-8eaf-eaea6198e3d5&contentId=fc-e87b01a6-e421-45aa-a709-370444e5509d&hId=34ad14d7c0b27631108e6fab33006000ba1c2ccc08c838cf358bc5fe2d67d89e" } ], "content": "", "positionId": "dg-b8cctmxxxx", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } } ] } }, "used": [ { "targetType": "Answer", "target": { "positionId": "dg-q2elu5xxxx", "status": "send", "displayTime": "2024-11-03T11:18:45.835Z", "showmoreClicked": false, "internalInfoMoreClicked": true, "answerLinkClicked": [] } } ] } ], "proActiveSuggestions": [ { "displayTime": "2024-11-03T11:13:39.687Z", "utterance": "order pizza", "countDisplayedAnswers": { "countDialogTasks": 1, "countFaqs": 2, "countWebPages": 10, "countFiles": 0, "countAnswers": 2, "countFromNonNativeDataSource": 0 }, "suggestions": { "dialogs": [ { "name": "cancel Pizza" } ], "answers": [ { "positionId": "dg-ytbtz5xxxx", "internalFlag": true, "content": [ "Place an order", "Don’t Blink", "Enjoy", "Categories" ], "sources": [ { "title": "How it Works", "url": "https://www.zeptonow.com/cn/munchies/newly-added/cid/d2c2a144-43cd-43e5-b308-92628fa68596/scid/0588d467-5aca-42f1-a2b6-b900850a3293" } ], "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxxx", "displayLines": 3 } }, { "positionId": "dg-3jfgklxxxx", "content": "To order pizza, you can follow these steps:\n\n1. Click the Orders tab.\n2. Select Awaiting shipping.\n3. Select the orders for which you want to purchase shipping labels by clicking the checkbox to the left of each.\n4. Go to Shipping actions > Print postage labels or invoices.\n5. On the next page, accept the default selection by clicking Continue.\n6. All the selected orders are loaded into the bulk shipping tab where you can enter the necessary info and purchase labels in bulk. \n\nPlease note that the provided information is related to printing shipping labels and not specifically about ordering pizza.", "sources": [ { "title": "Seller Hub - features, how to use", "url": "https://cskb.vip.ebay.com/cskbapp/art?page=content&id=GUIDE1446" }, {} ], "internalFlag": false, "appInfo": { "appName": "SearchAI App", "featureFlag": "external", "product": "searchai", "_id": "66a38213b98e4d773bxxxxxx", "displayLines": 4 } }, "positionId": "dg-kla8mntfat", "sources": [ { "title": "How it Works", "url": "https://www.zeptonow.com/cn/munchies/newly-added/cid/d2c2a144-43cd-43e5-b308-92628fa68596/scid/0588d467-5aca-42f1-a2b6-b900850a3293" } ], "internalFlag": false, "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxxx", "displayLines": 4 } } ], "faqs": [ { "sources": [ { "title": "Storage and stability", "url": "", "sourceType": "searchassist" } ], "content": "Storage and stability", "positionId": "dg-9h5f69xxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efe49xxxx", "displayLines": 3 } }, { "sources": [ { "title": "Storage and stability", "url": "", "sourceType": "searchassist" } ], "content": "Storage and stability", "positionId": "dg-9fon5ixxxx", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b261xxxx", "displayLines": 4 } } ], "web": [ { "sources": [ { "title": "Accessible Accounts & Services | Accessible Banking at Bank of America", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.bankofamerica.com%2Faccessible-banking%2Faccess-services%2F&requestId=fsh-281cc8d0-3864-5a47-8cab-a4699fc707af&contentId=fc-3112f7d3-d4d7-485b-8989-e4f7dc96efa7&hId=41755297e2b53611bb3397d94377cde5221617270216581139fff13e53a7bb4f" } ], "content": "", "positionId": "dg-chkli6xxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efe49xxxx", "displayLines": 3 } }, { "sources": [ { "title": "Buy cold drinks,fruit juices,energy drinks online at best prices - Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fcold-drinks-juices%2Fsoda-mixers%2Fcid%2F947a72ae-b371-45cb-ad3a-778c05b64399%2Fscid%2F0df54b3f-11f6-4ada-b38a-9be38ea25eba&requestId=fsh-281cc8d0-3864-5a47-8cab-a4699fc707af&contentId=fc-05b92bba-1a32-4a08-8627-303b1e3c5747&hId=5d2b8f016bacc0e0ba4bfe2fa9c4d52a9eaf3a4efdd040aab2d00cc3e72125c9" } ], "content": "", "positionId": "dg-7ds6jhxxxx", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efe4xxxx3", "displayLines": 3 } }, { "sources": [ { "title": "Shop your daily breakfast needs online - Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fbreakfast-sauces%2Fpeanut-butter%2Fcid%2Ff804bccc-c565-4879-b6ab-1b964bb1ed41%2Fscid%2F645a456e-adb6-4756-89d7-d9dda53738f8&requestId=fsh-281cc8d0-3864-5a47-8cab-a4699fc707af&contentId=fc-32d4d808-784e-4188-97eb-ca52cc2eb939&hId=9da9aa80500a917cc147e281cb6b734bf5d12307c8d92e38be27f38bfe8960e3" } ], "content": "", "positionId": "dg-y7jxixxxx1", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxd3", "displayLines": 3 } }, { "sources": [ { "title": "Buy chicken and meat online near me - Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fmeats-fish-eggs%2Fcold-cuts-marinated%2Fcid%2F4654bd8a-fb30-4ee1-ab30-4bf581b6c6e3%2Fscid%2F4c2742c5-f4ca-4454-90ef-17527af7160f&requestId=fsh-281cc8d0-3864-5a47-8cab-a4699fc707af&contentId=fc-5e98a480-264e-4331-9b58-e96a36440b76&hId=7b22a18a11c3995c36a898e81db6fff4e3ba8e9e7f260390f4ae47e570bfad19" } ], "content": "", "positionId": "dg-mubvwxxxxw", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399exxxx0cd3", "displayLines": 3 } }, { "sources": [ { "title": "Buy cold coffee from sleepy owl,starbucks near me- Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Ftea-coffee-more%2Fcoffee%2Fcid%2Fd7e98d87-6850-4cf9-a37c-e4fa34ae302c%2Fscid%2F0055bf0a-f578-4fa7-8b98-0c6e446bbe29&requestId=fsh-281cc8d0-3864-5a47-8cab-a4699fc707af&contentId=fc-3e985baa-5b17-4acb-b14d-9e3f33fcdcdd&hId=1147473d4bdb42052d680d0f6fd4cc29103658127af5a0fedabaad94a49c0916" } ], "content": "", "positionId": "dg-l0geoxxxxo", "appInfo": { "appName": "Internal", "featureFlag": "internal", "product": "searchai", "_id": "672759b39b14399efexxxxd3", "displayLines": 3 } }, { "sources": [ { "title": "Accessible Accounts & Services | Accessible Banking at Bank of America", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.bankofamerica.com%2Faccessible-banking%2Faccess-services%2F&requestId=fsh-136db328-cf1f-5bf4-843d-8d9bd7ee2306&contentId=fc-3112f7d3-d4d7-485b-8989-e4f7dc96efa7&hId=727552b95ff13deb86bfcb736359c4ea501af93f9b88c9e51bc35fdb9084944d" } ], "content": "", "positionId": "dg-29o0xxxxvq", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6bxxxx2f4", "displayLines": 4 } }, { "sources": [ { "title": "Buy cold drinks,fruit juices,energy drinks online at best prices - Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fcold-drinks-juices%2Fsoda-mixers%2Fcid%2F947a72ae-b371-45cb-ad3a-778c05b64399%2Fscid%2F0df54b3f-11f6-4ada-b38a-9be38ea25eba&requestId=fsh-136db328-cf1f-5bf4-843d-8d9bd7ee2306&contentId=fc-05b92bba-1a32-4a08-8627-303b1e3c5747&hId=e44904e1357f2789b943e85196af31b0a87878dc1f7796598d2ef091782443b4" } ], "content": "", "positionId": "dg-qhnnxxxx14", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6xxxxf2f4", "displayLines": 4 } }, { "sources": [ { "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fbreakfast-sauces%2Fpeanut-butter%2Fcid%2Ff804bccc-c565-4879-b6ab-1b964bb1ed41%2Fscid%2F645a456e-adb6-4756-89d7-d9dda53738f8&requestId=fsh-136db328-cf1f-5bf4-843d-8d9bd7ee2306&contentId=fc-32d4d808-784e-4188-97eb-ca52cc2eb939&hId=f8631a0017ffe52e164ecdb5dbd25c85ca3a6ce2d6c00c4099013cfdc667cdda" } ], "content": "", "positionId": "dg-usybxxxx9vk", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxf4", "displayLines": 4 } { "sources": [ "title": "Buy chicken and meat online near me - Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Fmeats-fish-eggs%2Fcold-cuts-marinated%2Fcid%2F4654bd8a-fb30-4ee1-ab30-4bf581b6c6e3%2Fscid%2F4c2742c5-f4ca-4454-90ef-17527af7160f&requestId=fsh-136db328-cf1f-5bf4-843d-8d9bd7ee2306&contentId=fc-5e98a480-264e-4331-9b58-e96a36440b76&hId=55c3cf0ca67c68cb3b07ff649c32e20d417ad747bedeab436b4a4a456ef229e3" } ], "content": "", "positionId": "dg-dcckxxxx3t", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6bxxxx2f4", "displayLines": 4 } }, { "sources": [ { "title": "Buy cold coffee from sleepy owl,starbucks near me- Zepto", "url": "https://searchassist-pilot.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.zeptonow.com%2Fcn%2Ftea-coffee-more%2Fcoffee%2Fcid%2Fd7e98d87-6850-4cf9-a37c-e4fa34ae302c%2Fscid%2F0055bf0a-f578-4fa7-8b98-0c6e446bbe29&requestId=fsh-136db328-cf1f-5bf4-843d-8d9bd7ee2306&contentId=fc-3e985baa-5b17-4acb-b14d-9e3f33fcdcdd&hId=1090bfa73a20109bc752ee8cee175f0eae1315a9fe264dffbea5d7cc9e0e790f" } ], "content": "", "positionId": "dg-kimhhxxxxh", "appInfo": { "appName": "External", "featureFlag": "external", "product": "searchai", "_id": "67275a02121f87c6b2xxxxf4", "displayLines": 4 } } ] }, "used": [ { "targetType": "Answer", "target": { "positionId": "dg-kla8xxxxat", "status": "send", "displayTime": "2024-11-03T11:14:48.496Z", "showmoreClicked": true, "internalInfoMoreClicked": false, "answerLinkClicked": [] } }, { "targetType": "DialogTask", "target": { "positionId": "dg-c64e3xxxxgg", "name": "cancel Pizza", "runType": "assist", "status": "", "startTime": "2024-11-03T11:14:42.947Z", "endTime": null, "suggestionsCount": { "tellCustomer": 0, "askCustomer": 1, "tellUsed": 0, "askUsed": 2 } }, "feedback": { "response": "Down", "reasonCode": [ "Accidental Click" ], "comment": "Thubs down option selected for the dialog feedback \" Accidental Click\"" } } ] }, { "displayTime": "2024-11-03T11:18:02.394Z", "utterance": "hi", "countDisplayedAnswers": { "countDialogTasks": 0, "countFaqs": 0, "countWebPages": 0, "countFiles": 0, "countAnswers": 0, "countFromNonNativeDataSource": 0 }, "suggestions": {}, "used": [] } ] }, { "conversationID": "c-de5a033-ec02-42be-b690-d86c6xxxx191", "botSessionID": "672761f52ccb73xxxx1897fb", "channel": "voice", "segmentID": "ac-ed8ca88-930e-43a5-9dbb-a7862c8xxxx1", "segmentStartTime": "2024-11-03T11:44:18.510Z", "segmentEndTime": "2024-11-03T11:47:12.204Z", "queueInfo": { "queueId": "qu-558c03b-1616-4e6c-9a58-60ed35xxxx61", "queueName": "Default Queue" }, "agent": { "agentName": "Anand C", "agentId": "u-058f5448-e74b-5981-a74d-20858xxxxaa7" }, "tags": [], "agentActions": [ { "actionType": "LibrarySelection", "used": [ { "targetType": "DialogTask", "target": { "positionId": "dg-ergqf5xxxx", "name": "DigitalForm", "runType": "assist", "status": "completed", "startTime": "2024-11-03T11:45:57.720Z", "endTime": "2024-11-03T11:46:32.878Z", "suggestionsCount": { "tellCustomer": 1, "askCustomer": 0, "tellUsed": 0, "askUsed": 0 } } } ] }, { "actionType": "LibrarySelection", "used": [ { "targetType": "DialogTask", "target": { "positionId": "dg-925prhxxxx", "name": "Hyperlink", "runType": "assist", "status": "", "startTime": "2024-11-03T11:46:35.209Z", "endTime": null, "suggestionsCount": { "tellCustomer": 1, "askCustomer": 1, "tellUsed": 0, "askUsed": 0 } } } ] } ], "proActiveSuggestions": [ { "displayTime": "2024-11-03T11:44:33.133Z", "utterance": "Hello.", "countDisplayedAnswers": { "countDialogTasks": 0, "countFaqs": 0, "countWebPages": 0, "countFiles": 0, "countAnswers": 0, "countFromNonNativeDataSource": 0 }, "suggestions": {}, "used": [] } ] } ], "hasMore": false }
Response Body Parameters
PARAMETER | TYPE AND FORMAT | DESCRIPTION AND EXAMPLE |
numResults | integer | number of results sent in this response |
hasMore | boolean (True / False) | if there are any more pages left with results.
Example: “false” without the double-quotes |
data | array of segment objects | Each segment is a part of a conversation that is driven by one primary agent. |
data[].conversationID | – | unique id of the conversation – from customer |
data[].botSessionID | alphanumeric string | unique id of the session – from Kore.
Example: “667fc3b587b5fd0fbfxxxxde” |
data[].channel | string | channel name – from customer.
Example: “chat” |
data[].segmentID | type-prefixed uuid | unique id of the segment, prefixed by “ac” – from Kore.
Example: “ac-de166b2-1e14-4141-9061-9bcaxxxxb068” |
data[].agent | object | object containing data of the primary agent servicing this portion (aka segment) of the conversation.
All data is optional (except agentID), and comes from the customer via the process API |
data[].agent.firstName | string | agent’s first name – from customer.
Example: “John” |
data[].agent.lastName | string | agent’s last name – from customer.
Example: “Smith” |
data[].agent.email | string of valid email address | agent’s email address – from customer.
Example: “john.smith@example.com” |
data[].agent.name | string | agent name – from customer.
Example: “John Smith” |
data[].agent.agentId | string | unique id of the agent- from customer.
Example: “jsmith01” |
data[].tags | array of tag objects | Each tag is one created by bot developers at various points in the Dialog.
All tags emitted by the bot at any point during this portion of the conversation will be returned here. |
data[].tags[].type | type of tag | can be a message-level tag, a session-level, or a user-level tag.
Example: one of “user”, ”message”, “session” |
data[].tags[].name | string | key value of the tag – from the client’s bot developer |
data[].tags[].value | string | value of the tag – from the client’s bot developer |
data[].tags[].messageID | type-prefixed uuid | UUID of the message (prefix: “ms”) that emitted this tag – from Kore.
Example: “ms-de166b2-1e14-4141-9061-9bca0xxxx068” |
data[].tags[].createdAt | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | UTC-based time when this tag was emitted.
Example: “2024-06-29T08:37:35.937Z” |
data[].segmentStartTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | UTC-based time when this portion of the conversation began.
Example: “2024-06-29T08:37:35.937Z” |
data[].segmentEndTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | UTC-based time when this portion of the conversation end.
Example: “2024-06-29T08:37:35.937Z” |
summary | Object | Contains the summary details of the interaction. |
summary.summary | String | A concise summary of the customer’s request and agent’s response.
Example: “The customer requested to order a pizza…” |
summary.editedSummary | String | An edited version of the summary, providing additional context or changes.
Example: “The customer requested to order a pizza… edited…” |
summary.isError | Boolean | Indicates if there was an error in the interaction.
Example: false |
summary.isDisabled | Boolean | Indicates if the summary is disabled.
Example: false |
summary.feedback | Object | Contains feedback related to the interaction. |
summary.feedback.response | String | The overall response from the feedback.
Example: “Down” |
summary.feedback.reasonCode | Array | List of reasons for the feedback.
Example: [“Inaccurate Content”, “Too Lengthy”, “Not Satisfactory”] |
summary.feedback.comment | String | Any additional comments from the user.
Example: “hehbdh” |
summary.isEdited | Boolean | Indicates if the summary has been edited.
Example: true |
summary.summaryModel | String | Indicates the model used for summarization.
Example: “kore” |
summary.time | Number (milliseconds) | The time taken for the process in milliseconds.
Example: 98.685 |
summary.exeStartTime | Number (milliseconds) | The execution start time in milliseconds since the epoch.
Example: 1727345858881 |
summary.agentId | String | The unique identifier for the agent handling the request.
Example: “phani-876” |
summary.sumSubTime | Number (milliseconds) | The time when the summary was submitted in milliseconds since the epoch.
Example: 1727345957566 |
data[].agentActions | array of objects | array of objects each of which denotes an Agent’s action, which can be:
1. Attempt to Search via Search Bar 2. Running a Dialog Task from the Library opening in Search bar |
data[].agentActions[].actionType | string | type of Agent’s action.
Example: one of “SearchBarEntry”, “LibrarySelection” |
data[].agentActions[].action | object | object containing data related to an Agent’s attempt to search.
Will be of type SearchBarEntry. |
data[].agentActions[].used | array of objects | objects detailing which of the SearchBarEntries or the DialogTasks
were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked |
data[].agentActions[].used[].targetType | string | specifies the type of object used by the agent.
Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource” |
data[].agentActions[].used[].target | object | object containing details of use of any Dialog Task or data source |
data[].proActiveSuggestions | array of objects | objects containing suggestions given proactively by Agent AI.
These can be: 1. Suggestions given proactively based on Customer’s latest utterance 2. Suggestions given proactively based on pre-shown text, such as Summary. |
data[].proActiveSuggestions[].utterance | string | entire utterance by the end Customer – redacted if redaction is enabled.
Example: “What is my account balance?” |
data[].proActiveSuggestions[].suggestions | Suggestion object | each Suggestion by Agent AI, whether it is a Dialog Task, an Answer, FAQ, Article or any other |
data[].proActiveSuggestions[].displayTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this list of suggestions was displayed (UTC).
Example: “2024-06-29T08:37:35.937Z” |
data[].proActiveSuggestions[].countDisplayedAnswers | object | contains counts of all displayed suggestions by type |
data[].proActiveSuggestions[].countDisplayedAnswers.countDialogTasks | integer | Number of Dialog Tasks suggested |
data[].proActiveSuggestions[].countDisplayedAnswers.countFaqs | integer | Number of FAQs suggested |
data[].proActiveSuggestions[].countDisplayedAnswers.countAnswers | integer | Number of Answers suggested |
data[].proActiveSuggestions[].countDisplayedAnswers.countFiles | integer | Number of Files suggested |
data[].proActiveSuggestions[].countDisplayedAnswers.countWebPages | integer | Number of Web pages suggested |
data[].proActiveSuggestions[].countDisplayedAnswers.countFromNonNativeDataSource | integer | Number of suggestions from non-native data sources |
data[].proActiveSuggestions[].used | array of objects | objects detailing which of the suggestions were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked |
data[].proActiveSuggestions[].used[].targetType | string | specifies the type of object used by the agent.
Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource” |
data[].proActiveSuggestions[].used[].target | object | object containing details of use of any Dialog Task or data source |
SearchBarEntry | object | This details an action by the Agent – when he enters text on the Search Bar. |
SearchBarEntry.searchPhrase | ||
SearchBarEntry.typingStartTime | ||
SearchBarEntry.executionStartTime | ||
SearchBarEntry.displayTime | ||
SearchBarEntry.countDisplayedAnswers | object | contains counts of all displayed suggestions by type |
SearchBarEntry.countDisplayedAnswers.countDialogTasks | integer | Number of Dialog Tasks suggested |
SearchBarEntry.countDisplayedAnswers.countFaqs | integer | Number of FAQs suggested |
SearchBarEntry.countDisplayedAnswers.countAnswers | integer | Number of Answers suggested |
SearchBarEntry.countDisplayedAnswers.countFiles | integer | Number of Files suggested |
SearchBarEntry.countDisplayedAnswers.countWebPages | integer | Number of Web pages suggested |
SearchBarEntry.countDisplayedAnswers.countFromNonNativeDataSource | integer | Number of suggestions from non-native data sources |
SearchBarEntry.suggestions | Suggestion object | each Suggestion by Agent AI, whether it is a Dialog Task, an Answer, FAQ, Article or any other |
DialogTask | object | This object is shown in a used array when a Dialog Task is run. |
DialogTask.name | string | name of the Dialog Task – from the client’s bot developer.
Example: “Cancel account” |
DialogTask.runType | string | How did the agent run it? Using the “Run” button, or the “Run with Agent input” button.
Example: one of “RunAssist”, “RunWithAgentInput” |
DialogTask.status | string | Outcome of the Dialog Task.
Example: one of “Completed”, “PrematurelyTerminated”, “TimedOut”, “Error” |
DialogTask.SuggestionsCount | object | count of suggestions made by Dialog Task by ask/tell prompt type. |
DialogTask.SuggestionsCount.askSuggestions | integer | count of suggestions that prompt with “Ask Customer” |
DialogTask.SuggestionsCount.tellSuggestions | integer | count of suggestions that prompt with “Tell Customer” |
DialogTask.SuggestionsCount.askUsed | integer | count of “Ask” suggestions that were sent or copied over to Customer |
DialogTask.SuggestionsCount.tellUsed | integer | count of “Tell” suggestions that were sent or copied over to Customer |
DialogTask.startTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this Dialog Task began to run
Example: “2024-06-29T08:37:35.937Z” |
DialogTask.endTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this Dialog Task ended its run.
Example: “2024-06-29T08:37:35.937Z” |
DialogTask.feedback | object | feedback given by Agent to this Dialog Task |
faq | object | this object is shown in a used array when an FAQ Q&A pair is used |
faq.title | string | Title of the FAQ Q&A pair.
Example: “FAQ 3.2” |
faq.status | string | How was it used? Sent or Copied?
Example: one of “Sent”, “Copied” |
faq.usedTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this FAQ was sent or copied.
Example: “2024-06-29T08:37:35.937Z” |
answer | object | this object is shown in a used array when an Answer from Search AI is used |
answer.status | string | shows if the Answer has been Sent or Copied. If not sent or copied, but used otherwise, it will be blank. “Used Otherwise” means its “Show more” may have been clicked, one of its links may have been clicked, or the Agent gave feedback to it.
Example: one of “Sent”, “Copied”, or blank |
answer.usedTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this Answer was sent or copied. If not, it will be blank.
Example: “2024-06-29T08:37:35.937Z” |
answer.showMoreClicked | boolean (True / False) | if the Show More button for this answer was clicked.
Example: “false” without the double-quotes |
answer.answerLinkClicked | array of URL links | links in the Answer clicked by the Agent.
Example: [“http://www.google.com“] |
answer.internalInfoMoreClicked | boolean (True / False) | if the Show More button for this answer was clicked.
Example: “false” without the double-quotes |
answer.positionId | type-prefixed uuid | prefixed by “dg-“, a position ID referring to a displayed suggestion in the “suggestions” object.
Example: “dg-3id77hxxxx” |
answer.feedback | object | feedback given by Agent to this Answer |
webpage | object | this object is shown in a used array when a webpage is used by the Agent |
webpage.url | string – URL | URL of the webpage |
webpage.status | string | How was it used? Sent or Copied?
Example: one of “Sent”, “Copied” |
webpage.usedTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this webpage was sent or copied.
Example: “2024-06-29T08:37:35.937Z” |
file | object | this object is shown in a used array when a file is used by the Agent |
file.path | string – filepath | path of the file.
Example: “/home/docs/configuration_parameters.doc” |
file.status | string | How was it used? Sent or Copied?
Example: one of “Sent”, “Copied” |
file.usedTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this file was sent or copied.
Example: “2024-06-29T08:37:35.937Z” |
general-data-source | object | this object is shown in a used array when a non-native data source is used by the Agent |
general-data-source.connector | string | name of the data source.
Example: “MSSharepoint” |
general-data-source.uri | URI | URI of the resource.
Example: “https://TestServer/TestSite/Reports/Doc/Company%20Sales.rdl“ |
general-data-source.status | string | How was it used? Sent or Copied?
Example: one of “Sent”, “Copied” |
general-data-source.usedTime | Date: YYYY-MM-DDTHH24:mm:SS.NNNZ | time at which this resource was sent or copied.
Example: “2024-06-29T08:37:35.937Z” |
feedback | object | contains feedback from an Agent to certain suggestions. |
feedback.response | string | The Agent can choose Thumbs Up or Down.
Example: one of “up”, “down” |
feedback.reasonCode | array of strings | the Agent may choose multiple reason codes, and these are configurable.
Example: [“Wrong Intent”, “Missed Context”] |
feedback.comment | string | freeform textual feedback from the Agent.
Example: “This is not the correct Dialog. The customer said ‘Cancel account’, and the Dialog is about renewal”. |
suggestions | object | containing all displayed suggestions, whether from a SearchBarEntry action by the Agent or a proActiveSuggestion triggered by a Customer’s utterance |
suggestions.dialogs | array of objects | each object contains the particulars of a DialogTask displayed to Agent |
suggestions.dialogs[].name | string | name of the DialogTask – from the client’s bot developer.
Example: “Cancel Account” |
suggestions.answers | array of objects | each object contains details of an Answer displayed |
suggestions.answers[].content | string | Generated Answer content.
Example: “A potentially very long answer that may be generated by an LLM”. |
suggestions.answers[].positionId | type-prefixed uuid | prefixed by “dg-“, this field acts as a key for this particular answer, later referred to by an Answer object in a used array.
Example: “dg-3id77hxxxx” |
suggestions.answers[].sources | array of objects | array of source links from which the Answer was generated. |
suggestions.answers[].sources[].title | string | Title of the page linked, that was one of the sources for the Answer.
Example: AWS EC2 On-demand pricing |
suggestions.answers[].sources[].url | string – URL | The link itself. |
suggestions.answers[].internalFlag | boolean (True / False) | Example: “false” without the double-quotes |