Jump to

• Request
• Response
• Examples

Get the 7-day and 30-day Simple Moving Average for user session duration

get

/appInsightsSessionSma

This method gets the 7-day and 30-day Simple Moving Average for session duration by day for all users.

Request

Query Parameters

• duration: string
  Specifies the historical time, in days, which the returned data represents.

  Default Value: 7D

  Allowed Values: [ "7D", "30D", "60D", "90D" ]
• managerGuid: string
  Specifies the unique manager id, to filter the returned data. To be used with team scope.
• 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: all

  Allowed Values: [ "all", "team" ]
• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object appinsightssma

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appinsightssma"
    }
}

Nested Schema : appinsightssma

Type: object

Show Source

• id: integer (int64)
• sma30: integer (int64)
• sma7: integer (int64)
• smaName: string
• statisticDate: string (date)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "statisticDate":{
            "type":"string",
            "format":"date"
        },
        "smaName":{
            "type":"string"
        },
        "sma7":{
            "type":"integer",
            "format":"int64"
        },
        "sma30":{
            "type":"integer",
            "format":"int64"
        }
    }
}

401 Response

Authentication Required

403 Response

Access Forbidden

Back to Top

Examples

The following example shows how to get the 7-day and 30-day sma for user session duration 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/appInsightsSessionSma

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "statisticDate": "10/7/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 2
        },
        {
            "statisticDate": "10/8/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 5
        },
        {
            "statisticDate": "10/9/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 8
        },
        {
            "statisticDate": "10/10/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 11
        },
        {
            "statisticDate": "10/11/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 14
        },
        {
            "statisticDate": "10/12/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 17
        },
        {
            "statisticDate": "10/13/21",
            "smaName": "Sessions",
            "sma7": 0,
            "sma30": 0,
            "id": 20
        }
    ]
}

Back to Top