The next monthly update in the frenetic release pace of Oracle Intelligent Advisor provides administrative users and other team members involved in User Acceptance and User Behavior with a new capability. System integrators and other users can now access the Oracle Intelligent Advisor Hub statistics module thereby allowing them to obtain information about the usage of deployed projects or for a specific deployed project.
Like all of the Oracle Intelligent Advisor REST API methods, you must use an Oracle Intelligent Advisor API Client and OAuth 2 in order to be able to authenticate and access this information. Naturally this can be automated if required through scripting or other approaches.
The basic format of the request is as simple as https://{your_site_interface}/opa-hub/api/12.2.23/statistics as a POST with an input object containing information about what you want to have statistics of. This object is basically a deployment name and version, and various parameters so that the backend can work out exactly which project, version or statistics set you are interested in. Assuming I have a deployed interview called RN_CG for example, might give me the following POST body as an example:
{
"metric": "interviewsByScreenDuration",
"deploymentVersionSeries": [
{
"deploymentName": "RN_CG",
"deploymentState": "active"
}
],
"timePeriod": "last30Days",
"groupBy": "screenName",
"includedActionTypes": [
"nonAgentInterviews"
]
}As you can see the majority of the information is familiar to anyone who has taken a look at the statistics features of Oracle Intelligent Advisor, with the concepts of deployment series, grouping and periods all showing up in most of the screens:
The documentation for the statistics REST API can be found in the REST API site (why do we have two different sites for Intelligent Advisor documentation – I find that extremely time-wasting and it results in a lot of time spent jumping between the two).
The output looks like a stream of conciousness from the charting engine 🙂 :
{
"chartTitle": "Interview screens by time spent",
"metricTitle": "Interview screens by time spent",
"valueTitle": "Average Time per Session (seconds)",
"categoryTitle": "Interview Screen",
"includedActionTypes": [
"nonAgentInterviews"
],
"data": [
{
"value": 8.637,
"series": "RN_CG:Active",
"category": "1: Code Creator"
},
{
"value": 2.537,
"series": "RN_CG:Active",
"category": "2: Basic Options"
},
{
"value": 1.182,
"series": "RN_CG:Active",
"category": "3: Custom Label Template Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "4: Custom Question Text Options"
},
{
"value": 10.369333300000001,
"series": "RN_CG:Active",
"category": "5: Custom Input Template Option"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "6: Custom Image Template Option"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "7: Custom Full Input Template Option"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "8: Custom Search Initial Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "9: Custom Button Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "10: Custom Search Template Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "11: Custom Entity Container Options"
},
{
"value": 2.6945,
"series": "RN_CG:Active",
"category": "12: Custom Options Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "13: Custom Container Options"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "14: Custom Entity Remove Instance Button"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "15: Custom Entity Add Instance Button"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "16: Custom Navigation Bar"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "17: Custom Upload Add Button"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "18: Custom On Events"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "19: Custom File Upload Options"
},
{
"value": 86.69875,
"series": "RN_CG:Active",
"category": "20: Code Generated"
},
{
"value": 0,
"series": "RN_CG:Active",
"category": "21: Download a Guide in PDF"
}
]
}The large number of combinations of parameters (what you can group by, time segments, how to access the versions of a deployment and so on) are listed in the online documentation at the link shown above. In the meantime, I hope you are enjoying (if you are in the Northern half of the planet) your summer vacation, and see you soon on the site.