4.1.2. Sessions (Get) 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 various details. | GET | 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 after this time will be added to the selection. | string | Examples: "2021-04-01" "2021-04-01T12:00" "2021-04-01T12:00:00" | 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 |
clientGuid (string) | The GUID of the Client. | [ { "clientGuid" : "1d4fegdr-g3ff-4114-a814-f3aeee14dgdg", |
logoutDate (date-time) | The date & time when the session ended. | |
| loginDate (date-time) | The date & time when the session started. | |
| sessionId (int32) | The ID of the session. | |
| userId (int32) | The ID of the user. | |