4.1.3. Sessions (Post) Endpoint
NOT AVAILABLE IN SAAS
Request URL: https://<hostname>/ekranapi/sessions
Name | Description | Type | Request Parameters | ||||
Name | Description | Type | Format | Required | |||
Sessions | Gets a list of sessions with details (including productivity time, idle time, and duration). | POST | start | Sessions that were started or finished after this time will be added to the selection. | string | Examples: "2021-04-01" "2021-04-01T12:00" "2021-04-01T12:00:00" | No |
end | Sessions that were started or finished before this time will be added to the selection. | string | Examples: "2021-04-01" "2021-04-01T12:00" "2021-04-01T12:00:00" | No | |||
sessionCount | The number of sessions to be returned within 1 request. Default value: 1000 Max value: 1000 | int32 | Any integer from 0 to 1000. | No | |||
pageIndex | The page number to be returned starting from the page number with this page index within the session. | int32 | Any integer from 0 upwards. | No |
Notes:
1. If optional time parameters are not specified in the Session Details request:
- If both the start and end parameters are not specified, all sessions in the database are added to the response.
- If the start parameter is not specified, all sessions that were started before the end date/time are added to the response.
- If the end parameter is not specified, all sessions that were started or finished after the start date/time are added to the response.
2. If the session was started before the start date/time, the first activity after the start date/time is considered as the session start.
3. If the session was finished after the end date/time, the last activity before the end date/time is considered as the session end.
The Sessions response (status 200 = successful):
Response Parameters | ||
Name (& Type) | Description | Example Response |
sessions: | The list of sessions (with detailed info for each session): | { "duration": "20:20:40.0020000", |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
totalCount (int32) |
|
NOTE: If the requested session count is more than 1000, a status code of "400" is returned.