Connection History
On this page, you will find descriptions of the API methods intended for working with historical connection data from the Connection History section.
Session List¶
To get a history of your connections, use the history/list method.
Request:
curl -G "https://api.getscreen.me/v1/history/list" \
--data-urlencode "agent_id=<number>" \
--data-urlencode "support_id=<number>" \
--data-urlencode "date_from=<unixtime>" \
--data-urlencode "date_to=<unixtime>" \
--data-urlencode "video=<boolean>" \
--data-urlencode "offset=<number>" \
--data-urlencode "limit=<number>" \
-H "X-Api-Key: YOUR_API_KEY"
| Parameter | Type | Value |
|---|---|---|
agent_id | string | Filter by agent ID |
support_id | number | Filter by invitation ID |
date_from | unixtime | Filter by date and time: period start |
date_to | unixtime | Filter by date and time: period end |
video | boolean | Filter by video recording |
offset | number | Offset for the first item in the list |
limit | number | Number of items in the list. Default value: 20; maximum value: 100 |
Response:
Example Response
Response Data
{
"offset": 0,
"limit": 10,
"total": 15,
"filter": {
"date_from": 1608660281,
"date_to": 1608660389,
"agent_id": 1001,
"support_id": 1002,
"video": true
},
"data": [ {
"id": 27233,
"start": 1608660273,
"stop": 1608660281,
"support_id": 1002,
"client": [ {
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
"login": "[email protected]",
"geo": {
"ip": "2.21.31.68",
"country": "USA",
"region": "California",
"city": "Los Angeles"
}
} ],
"agent": {
"id": 1001,
"name": "DESKTOP-SJBU5PO",
"group": "Accounting",
"geo": {
"ip": "2.21.31.68",
"country": "USA",
"region": "California",
"city": "Los Angeles"
},
"os": "win",
"version": "2.1.5",
"owner": "[email protected]"
},
"video": {
"url": "https://st.getscreen.me/video/2/27233.mp4",
"size": 428652
}
}, ... ]
}
| Name | Type | Description |
|---|---|---|
id | number | Internal system connection ID |
start | unixtime | Connection start date and time |
stop | unixtime | Connection end date and time Can be empty if the connection is not ended |
support_id | number | Invitation connection ID The field may be blank if there was a connection to a Permanent Access device |
client | array | List of clients who joined the connection |
client[].user_agent | string | User agent |
client[].login | string | User login Can be empty if the connection was anonymous |
client[].geo | object | Location |
client[].geo.ip | string | IP address |
client[].geo.country | string | Country |
client[].geo.region | string | Region |
client[].geo.city | string | City |
agent | object | Agent info |
agent.id | number | Internal system agent ID |
agent.name | string | Name |
agent.group | string | Group |
agent.geo | object | Location |
agent.geo.ip | string | IP address |
agent.geo.country | string | Country |
agent.geo.region | string | Region |
agent.geo.city | string | City |
agent.os | string | Operating system. Possible values: win, mac, linux or android |
agent.version | string | Software version |
agent.owner | string | Account login of the permanent access owner |
video | object | Video recording info Can be missing if the connection was not recorded |
video.url | string | Video recording file address To download a file with a video recording of the connection, add the ?apikey= parameter with your API key. |
video.size | number | Video recording file size in bytes |
Session Info¶
To get information about a specific connection, use the history/info method.
Request:
| Parameter | Type | Value |
|---|---|---|
session_id | number | Internal session identifier |
session_uid | string | Unique session identifier |
Response:
Example Response
Response Data
{
"id": 10573011,
"uid": "17542170487lJDSVaYcCPB2urQWvod1dipT8VlSWj41414945",
"agent_id": 1405303,
"account_id": 7915,
"agent_account_id": 0,
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
"start": 1754217049,
"stop": 1754217227,
"video": "https://st.getscreen.me/video/1405303/10500000.mp4",
"video_size": 7530661,
"turbo_one_time": false,
"visor_comment": "",
"url": "/mn3-u1r-e7u",
"mode": "control",
"client": {
"ip": "2.21.31.68",
"country": "USA",
"region": "California",
"city": "Los Angeles"
},
"agent": {
"ip": "2.21.31.68",
"country": "USA",
"region": "Bashkortostan Republic",
"city": "Sterlitamak"
}
}
| Name | Type | Description |
|---|---|---|
id | number | Internal system connection ID |
uid | string | Unique session identifier |
agent_id | number | Internal system agent ID |
account_id | number | Internal identifier of the technician |
agent_account_id | number | Identifier of the account to which the device is linked |
start | unixtime | Connection start date and time |
stop | unixtime | Connection end date and time Can be empty if the connection has not ended |
video | object | Video recording info Can be missing if the connection was not recorded |
video.url | string | Video recording file URL To download the video recording file, append the ?apikey= parameter with your API key. |
video.size | number | Video recording file size in bytes |
turbo_one_time | boolean | Indicates whether the session was established via a one-time link |
visor_comment | string | Comment |
url | string | URL used for the connection |
mode | string | Connection type. Possible values:
|
client | object | Information about the technician who connected |
client.ip | string | IP address |
client.country | string | Country |
client.region | string | Region |
client.city | string | City |
agent | object | Device information |
agent.ip | string | IP address |
agent.country | string | Country |
agent.region | string | Region |
agent.city | string | City |