Get ZVA Query Details
GET {{baseUrl}}/virtual_agent/report/engagements/query_details?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&engagement_ids=<string>
Returns a list of ZVA engagement query details.
Scopes: zva_report:read
Rate Limit Label: HEAVY
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours. | |
to | string | The field is required only when the from parameter is specified. The end time and date is in the yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, which is the same format as the from parameter. | |
timezone | string | The call's timezone ID. The default is UTC. | |
page_size | number | The number of items returned per page. | |
| Constraints: Max: 100 Default: 10 | |||
next_page_token | string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
engagement_ids | string | The engagement IDs string separated by ",". |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","next_page_token":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","timezone":"\u003cstring\u003e","engagement_query_details":[{"engagement_id":"\u003cstring\u003e","query_details":[{"query_id":"\u003cstring\u003e","bot_id":"\u003cstring\u003e","bot_session_id":"\u003cstring\u003e","query_time":"\u003cdateTime\u003e","language_code":"en-US","query_text":"\u003cstring\u003e","intents":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true}],"articles":[{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]},{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]}]},{"query_id":"\u003cstring\u003e","bot_id":"\u003cstring\u003e","bot_session_id":"\u003cstring\u003e","query_time":"\u003cdateTime\u003e","language_code":"en-US","query_text":"\u003cstring\u003e","intents":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true}],"articles":[{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]},{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]}]}]},{"engagement_id":"\u003cstring\u003e","query_details":[{"query_id":"\u003cstring\u003e","bot_id":"\u003cstring\u003e","bot_session_id":"\u003cstring\u003e","query_time":"\u003cdateTime\u003e","language_code":"en-US","query_text":"\u003cstring\u003e","intents":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true}],"articles":[{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]},{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]}]},{"query_id":"\u003cstring\u003e","bot_id":"\u003cstring\u003e","bot_session_id":"\u003cstring\u003e","query_time":"\u003cdateTime\u003e","language_code":"en-US","query_text":"\u003cstring\u003e","intents":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":true}],"articles":[{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]},{"article_id":"\u003cstring\u003e","article_title":"\u003cstring\u003e","article_answer":"\u003cstring\u003e","article_url":"\u003cstring\u003e","article_score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"},{"group_id":"\u003cstring\u003e","group_name":"\u003cstring\u003e"}]}]}]}]}]}