Get ZVA Engagements

GET {{baseUrl}}/virtual_agent/report/engagements?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&include_query_detail=<boolean>

Generate a list of ZVA engagements.

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, return data from the past 24 hours. | | to | string | | Required only when the from parameters is specified. The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, 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 | | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | | include_query_detail | string | | If engagement response includes query details. |

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{"next_page_token":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","timezone":"\u003cstring\u003e","engagements":[{"engagement_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","duration":"\u003cinteger\u003e","campaign_name":"\u003cstring\u003e","global_variables":[{"type":"\u003cstring\u003e","value":"\u003cstring\u003e","group_name":"\u003cstring\u003e","group_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","need_mask":"\u003cboolean\u003e","need_store":"\u003cboolean\u003e"},{"type":"\u003cstring\u003e","value":"\u003cstring\u003e","group_name":"\u003cstring\u003e","group_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","need_mask":"\u003cboolean\u003e","need_store":"\u003cboolean\u003e"}],"outcome":"\u003cstring\u003e","launch_url":"\u003cstring\u003e","query_summary":{"query_ids":["\u003cstring\u003e","\u003cstring\u003e"],"count":"\u003cinteger\u003e"},"Intent_summary":{"intents_matched":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"count":"\u003cinteger\u003e"},"language_code":"en-US","query_details":[{"query_id":"\u003cstring\u003e","engagement_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":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"articles":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]},{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]}]},{"query_id":"\u003cstring\u003e","engagement_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":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"articles":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]},{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]}]}],"end_time":"\u003cdateTime\u003e"},{"engagement_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","duration":"\u003cinteger\u003e","campaign_name":"\u003cstring\u003e","global_variables":[{"type":"\u003cstring\u003e","value":"\u003cstring\u003e","group_name":"\u003cstring\u003e","group_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","need_mask":"\u003cboolean\u003e","need_store":"\u003cboolean\u003e"},{"type":"\u003cstring\u003e","value":"\u003cstring\u003e","group_name":"\u003cstring\u003e","group_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","need_mask":"\u003cboolean\u003e","need_store":"\u003cboolean\u003e"}],"outcome":"\u003cstring\u003e","launch_url":"\u003cstring\u003e","query_summary":{"query_ids":["\u003cstring\u003e","\u003cstring\u003e"],"count":"\u003cinteger\u003e"},"Intent_summary":{"intents_matched":[{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"count":"\u003cinteger\u003e"},"language_code":"en-US","query_details":[{"query_id":"\u003cstring\u003e","engagement_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":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"articles":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]},{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]}]},{"query_id":"\u003cstring\u003e","engagement_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":"\u003cboolean\u003e"},{"intent_id":"\u003cstring\u003e","intent_name":"\u003cstring\u003e","intent_type":"default_intent","accuracy":"\u003cnumber\u003e","system_intent":"\u003cboolean\u003e"}],"articles":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]},{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","answer":"\u003cstring\u003e","url":"\u003cstring\u003e","score":"\u003cnumber\u003e","kb_details":[{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"kb_id":"\u003cstring\u003e","kb_name":"\u003cstring\u003e","kb_groups":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}]}]}],"end_time":"\u003cdateTime\u003e"}],"from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e"}