# Cobrowse
## 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 |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | string | This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00 |
| output | string | json or csv |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"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"
}
}
}
```
{% endtab %}
{% endtabs %}
## 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
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| output | string | json or csv |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | string | This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00 |
| channel | string | channel \| phone \| email |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"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"
}
}
}
```
{% endtab %}
{% endtabs %}
## 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
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| output | string | json or csv |
| start\_date | string | Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00) |
| end\_date | string | Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59) |
| offset | string | This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00 |
#### Headers
| Name | Type | Description |
| ------------- | ------ | --------------------------------- |
| Authorization | string | Bearer \*\*\*YOUR\_API\_KEY\*\*\* |
{% tabs %}
{% tab title="200 " %}
```
{
"data": {
"coBrowsePageSource": {
"data": {
"graphRow": {
"data": [
{
"pageUrl": "https://test1.acquire.io/simulate",
"pageVisited": 2
}
]
}
},
"success": true,
"output": "json"
}
}
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://developer.acquire.io/rest-apis/analytics/cobrowse.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.