This documentation supports the 20.08 version of BMC Helix Platform.  To view an earlier version, select 20.02 from the Product version menu.

Chatbot user feedback report using REST API

The EventMetricsDataPageQuery REST API is used to get user feedback report.

Use the following syntax for EventMetricsDataPageQuery:

<<URL>>/api/rx/application/datapage?dataPageType=com.bmc.arsys.rx.application.event.datapage.EventMetricsDataPageQuery
&startIndex=0
&eventDefinition=<<Fully qualified-event-name>>
&fromDate=<<START_DATE_TIME>> (date must be in UTC format)
&toDate=<<END_DATE_TIME>> (date must be in UTC format)
&pageSize=-1

Which includes the following parameters:

Parameter

Description

dataPageType

  • Specifies the fully qualified class name of the com.bmc.arsys.rx.application.event.datapage.EventMetricsDataPageQuery. 
  • This is a mandatory query parameter. 

Note: Do not change the value of this parameter.

pageSize

  • This value should be always -1. This is a mandatory query parameter.

startIndex

  • This is a mandatory query parameter.

For example: If startIndex=0 and pageSize=-1, the dataPageQuery will return the all the events based on the criteria specified. 

eventDefinition

Specifies fully qualified event name.

fromDate

yyyy-MM-ddTHH:mm:ss.SSS. The date must be in UTC format. For example: 2019-10-01T10:00:00.000

toDate

yyyy-MM-ddTHH:mm:ss.SSS. The date must be in UTC format. For example: 2019-10-31T10:00:00.000

Example 1

To fetch the retrieve/fetch the user feedback events, use the following REST API call: 

https://<IS_SERVER_NAME>/api/rx/application/datapage?dataPageType=com.bmc.arsys.rx.application.event.datapage.EventMetricsDataPageQuery&startIndex=0&eventDefinition =com.bmc.dsm.chatbot:User Feedback&fromDate=2019-10-01T10:00:00.000&toDate=2019-10-31T10:00:00.000&pageSize=-1

In this example, all events from com.bmc.dsm.chatbot:User Feedback will be fetched from date 10 am on 1st October 2019 to 10 am on 31st October 2019. 

Related topics


Providing feedback using BMC Helix Chatbot User survey

Configuring the survey dialog nodes in IBM Watson Assistant Skills