Website Guide & Tutorial Blog Book a Demo

Cobrowse

Retrieve data for your cobrowse sessions.

PreviousVideo Analytics NextChatbot

Last updated 3 years ago

Overview

GET https://{{account_id}}.acquire.io/api/v1/analytics/cobrowse/cobrowse

Retrieve a a list of cobrowse metrics, including sessions, durations, and visited pages.

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

{
  "data": {
    "cobrowse": {
      "data": {
        "graphRow": {
          "labels": [
            "03 PM",
            "04 PM",
            "05 PM",
            "06 PM",
            "07 PM",
            "08 PM",
            "09 PM",
            "10 PM",
            "11 PM",
            "12 AM",
            "01 AM",
            "02 AM",
            "03 AM",
            "04 AM",
            "05 AM",
            "06 AM",
            "07 AM",
            "08 AM",
            "09 AM",
            "10 AM",
            "11 AM",
            "12 PM",
            "01 PM",
            "02 PM"
          ],
          "totalCobrowseSession": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "totalPageVisited": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "averageSessionTime": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ]
        },
        "summary": {
          "totalCobrowseSession": {
            "current": 0,
            "previous": 0
          },
          "totalCobrowseTime": {
            "current": 0,
            "previous": 0
          },
          "averageSessionTime": {
            "current": 0,
            "previous": 0
          },
          "totalPageVisited": {
            "current": 0,
            "previous": 0
          }
        }
      },
      "success": true,
      "output": "json"
    }
  }
}

Cobrowse with Chat

GET https://{{account_id}}.acquire.io/api/v1/analytics/cobrowse/co-browse-channel-wise

Retrieve a list of session data, including average session time, for cobrowse chat sessions.

Query Parameters

Headers

{
  "data": {
    "coBrowseChannelWise": {
      "data": {
        "graphRow": {
          "labels": [
            "03 PM",
            "04 PM",
            "05 PM",
            "06 PM",
            "07 PM",
            "08 PM",
            "09 PM",
            "10 PM",
            "11 PM",
            "12 AM",
            "01 AM",
            "02 AM",
            "03 AM",
            "04 AM",
            "05 AM",
            "06 AM",
            "07 AM",
            "08 AM",
            "09 AM",
            "10 AM",
            "11 AM",
            "12 PM",
            "01 PM",
            "02 PM"
          ],
          "totalSessions": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "averageSessionTime": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "totalCoBrowseTime": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ]
        },
        "summary": {
          "totalSessions": {
            "current": 0,
            "previous": 0
          },
          "averageSessionTime": {
            "current": 0,
            "previous": 0
          },
          "totalCoBrowseTime": {
            "current": 0,
            "previous": 0
          }
        }
      },
      "success": true,
      "output": "json"
    }
  }
}

Cobrowse Page Source

GET https://{{account_id}}.acquire.io/api/v1/analytics/cobrowse/co-browse-page-source

Retrieve a list and count of the urls visited during cobrowse sessions.

Query Parameters

Headers

{
  "data": {
    "coBrowsePageSource": {
      "data": {
        "graphRow": {
          "data": [
            {
              "pageUrl": "https://test1.acquire.io/simulate",
              "pageVisited": 2
            }
          ]
        }
      },
      "success": true,
      "output": "json"
    }
  }
}