Jump to

• Request
• Response
• Examples

Get the top flows by click count

get

/popflows

This method gets the top flows by the number of clicks in the flow.

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 popularflows

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

Nested Schema : popularflows

Type: object

Show Source

• averageResponseTime: integer (int64)
• clicks: integer (int64)
• id: integer (int64)
• name: string
• series: string
• users.: array users.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "series":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "clicks":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "users.":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/flownamesusers"
            }
        }
    }
}

Nested Schema : users.

Type: array

Show Source

• Array of: object flownamesusers

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

Nested Schema : flownamesusers

Type: object

Show Source

• averageResponseTime: integer (int64)
• clicks: integer (int64)
• manager: string
• managerGuid: string
• name: string
• region: string
• regionCode: string
• role: string
• roleId: string
• userGuid: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "clicks":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "manager":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "region":{
            "type":"string"
        },
        "roleId":{
            "type":"string"
        },
        "managerGuid":{
            "type":"string"
        },
        "regionCode":{
            "type":"string"
        },
        "userGuid":{
            "type":"string"
        }
    }
}

401 Response

Authentication Required

403 Response

Access Forbidden

Back to Top

Examples

The following example shows how to get the top flows by click count 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/popflows

Example of Response Body

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

{
    "items": [
        {
            "id": 0,
            "series": "All",
            "name": "Workspace",
            "clicks": 18,
            "averageResponseTime": 41,
            "Users": []
        },
        {
            "id": 1,
            "series": "All",
            "name": "Credits and Earnings",
            "clicks": 6,
            "averageResponseTime": 0,
            "Users": []
        },
        {
            "id": 2,
            "series": "All",
            "name": "Access Groups",
            "clicks": 3,
            "averageResponseTime": 62,
            "Users": []
        },
        {
            "id": 3,
            "series": "All",
            "name": "Contextual Help",
            "clicks": 1,
            "averageResponseTime": 0,
            "Users": []
        }
    ]
}

Back to Top