Get summaries of metrics
get
/quickfacts
This method gets the summaries of metrics by day.
Request
Query Parameters
-
duration: string
Specifies the historical time, in days, which the returned data represents.Default Value:
7DAllowed Values:[ "7D", "30D", "60D", "90D" ] -
managerGuid: string
Specifies the unique manager id, to filter the returned data. To be used with team scope.
-
objectList: string
Specifies the parent object name of the interactions metrics.
-
regionCode: string
Specifies the unique region code, to filter the returned data. To be used with team scope.
-
roleIdList: string
Specifies the unique role id, to filter the returned data. To be used with team scope.
-
scope: string
Specifies the scope of the returned data. Team returns team data. Org returns organization data.Default Value:
allAllowed Values:[ "all", "team" ] -
subQuery: string
Specifies the targetted quick facts metrics of the returned data.Allowed Values:
[ "topFlowsClicks", "totalClicks", "topFlowsDuration", "logins", "sessionDuration", "objectUsage", "Interactions" ] -
topflownum: string
Specifies number flows to summarize.Default Value:
30 -
userGuid: string
Specifies the unique user id, to filter the returned data. To be used with team scope.
There's no request body for this operation.
Security
-
BasicAuth: http
Type:
http
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : fullquickfacts
Type:
Show Source
object-
accountCreates: integer
(int64)
-
accountCreatesDistinctUsers: integer
(int64)
-
accountCreatesGrowthCount: integer
(int64)
-
accountCreatesPercentGrowth: integer
(int64)
-
accountCreatesPercentusers.: integer
(int64)
-
accountCreatesPerDay: integer
(int64)
-
activityCreates: integer
(int64)
-
activityCreatesDistinctUsers: integer
(int64)
-
activityCreatesGrowthCount: integer
(int64)
-
activityCreatesPercentGrowth: integer
(int64)
-
activityCreatesPercentusers.: integer
(int64)
-
activitytCreatesPerDay: integer
(int64)
-
contactCreates: integer
(int64)
-
contactCreatesDistinctUsers: integer
(int64)
-
contactCreatesGrowthCount: integer
(int64)
-
contactCreatesPercentGrowth: integer
(int64)
-
contactCreatesPercentusers.: integer
(int64)
-
contactCreatesPerDay: integer
(int64)
-
count: integer
(int64)
-
countChange: integer
(int64)
-
customerCreates: integer
(int64)
-
customerCreatesDistinctUsers: integer
(int64)
-
customerCreatesGrowthCount: integer
(int64)
-
customerCreatesPercentGrowth: integer
(int64)
-
customerCreatesPercentusers.: integer
(int64)
-
customerCreatesPerDay: integer
(int64)
-
distinctClickUserCount: integer
(int64)
-
distinctUsers: integer
(int64)
-
flowDurationPercentTimeSpent: integer
(int64)
-
flowDurationTimeSpent: integer
(int64)
-
interactionObjectName: string
-
leadCreates: integer
(int64)
-
leadCreatesDistinctUsers: integer
(int64)
-
leadCreatesGrowthCount: integer
(int64)
-
leadCreatesPercentGrowth: integer
(int64)
-
leadCreatesPercentusers.: integer
(int64)
-
leadCreatesPerDay: integer
(int64)
-
loginsAvgSignIns: integer
(int64)
-
loginsPercentSignInGrowth: integer
(int64)
-
loginsPercentusers.: integer
(int64)
-
loginsTotalSignIns: integer
(int64)
-
mode: string
-
noteCreates: integer
(int64)
-
noteCreatesDistinctUsers: integer
(int64)
-
noteCreatesGrowthCount: integer
(int64)
-
noteCreatesPercentGrowth: integer
(int64)
-
noteCreatesPercentusers.: integer
(int64)
-
noteCreatesPerDay: integer
(int64)
-
opportunityCreates: integer
(int64)
-
opportunityCreatesDistinctUsers: integer
(int64)
-
opportunityCreatesGrowthCount: integer
(int64)
-
opportunityCreatesPercentGrowth: integer
(int64)
-
opportunityCreatesPercentusers.: integer
(int64)
-
opportunityCreatesPerDay: integer
(int64)
-
parentObjectName: string
-
servicerequestCreates: integer
(int64)
-
servicerequestCreatesDistinctUsers: integer
(int64)
-
servicerequestCreatesGrowthCount: integer
(int64)
-
servicerequestCreatesPercentGrowth: integer
(int64)
-
servicerequestCreatesPercentusers: integer
(int64)
-
servicerequestCreatesPerDay: integer
(int64)
-
sessionDurationPercentTimeGrowth: integer
(int64)
-
sessionDurationPerUserTime: integer
(int64)
-
sessionDurationPerUserTotalTime: integer
(int64)
-
totalClicksPercentGrowth: integer
(int64)
-
totalClicksPercentusers.: integer
(int64)
-
totalClicksPerDay: integer
(int64)
-
totalFlowsAverageClicks: integer
(int64)
-
totalFlowsClickCount: integer
(int64)
-
totalFlowsDistinctUsers: integer
(int64)
-
totalFlowsPercentClicks: integer
(int64)
-
totalFlowsPercentusers.: integer
(int64)
-
totalusers.: integer
(int64)
401 Response
Authentication Required
403 Response
Access Forbidden
Examples
The following example shows how to get summaries of metrics by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/crmRestApi/clickhistory/resources/quickfacts
Example of Response Body
The following shows an example of the response body in JSON format.
{
"totalFlowsPercentClicks": 18,
"totalFlowsAverageClicks": 1,
"flowDurationPercentTimeSpent": 20,
"flowDurationTimeSpent": 0,
"loginsPercentUsers": 0,
"loginsTotalSignIns": 0,
"contactCreates": 0,
"contactCreatesPercentGrowth": 0,
"contactCreatesPerDay": 0,
"contactCreatesPercentUsers": 0,
"activityCreates": 0,
"activityCreatesPercentGrowth": 0,
"activityCreatesPerDay": 0,
"activityCreatesPercentUsers": 0,
"customerCreates": 0,
"customerCreatesPercentGrowth": 0,
"customerCreatesPerDay": 0,
"customerCreatesPercentUsers": 0,
"noteCreates": 0,
"noteCreatesPercentGrowth": 0,
"noteCreatesPerDay": 0,
"noteCreatesPercentUsers": 0,
"servicerequestCreates": 0,
"servicerequestCreatesPercentGrowth": 0,
"servicerequestCreatesPerDay": 0,
"servicerequestCreatesPercentUsers": 0,
"distinctUsers": 0,
"distinctClickUserCount": 74,
"totalFlowsClickCount": 5,
"totalFlowsDistinctUsers": 2,
"accountCreatesGrowthCount": 0,
"opportunityCreatesGrowthCount": 0,
"leadCreatesGrowthCount": 0,
"contactCreatesGrowthCount": 0,
"activityCreatesGrowthCount": 0,
"customerCreatesGrowthCount": 0,
"noteCreatesGrowthCount": 0,
"servicerequestCreatesGrowthCount": 0,
"accountCreatesDistinctUsers": 0,
"opportunityCreatesDistinctUsers": 0,
"leadCreatesDistinctUsers": 0,
"contactCreatesDistinctUsers": 0,
"activityCreatesDistinctUsers": 0,
"customerCreatesDistinctUsers": 0,
"noteCreatesDistinctUsers": 0,
"servicerequestCreatesDistinctUsers": 0,
"totalClicksPercentUsers": 0,
"totalUsers": 43146,
"totalClicksPercentGrowth": -15,
"totalFlowsPercentUsers": 0,
"accountCreatesPercentUsers": 0,
"opportunityCreates": 0,
"opportunityCreatesPercentGrowth": 0,
"opportunityCreatesPerDay": 0,
"opportunityCreatesPercentUsers": 0,
"leadCreates": 0,
"leadCreatesPercentGrowth": 0,
"leadCreatesPerDay": 0,
"leadCreatesPercentUsers": 0,
"loginsAvgSignIns": 0,
"loginsPercentSignInGrowth": 0,
"sessionDurationPerUserTime": 0,
"sessionDurationPerUserTotalTime": 0,
"sessionDurationPercentTimeGrowth": 0,
"accountCreates": 0,
"accountCreatesPercentGrowth": 0,
"accountCreatesPerDay": 0,
"totalClicksPerDay": 4
}