4.1.3. Sesje (POST)

Uwaga: Usługa nie jest dostępna w wersji SaaS

URL żądania:

https:///<hostname>/ekranapi/sessions

Parametry żądania:

Nazwa	Opis	Typ	Format	Wymagane
start	Sesje rozpoczęte lub zakończone po tej dacie zostaną uwzględnione w odpowiedzi.	string	Przykłady: `"2021-04-01"`, `"2021-04-01T12:00"`	Nie
end	Sesje rozpoczęte lub zakończone przed tą datą zostaną uwzględnione w odpowiedzi.	string	jw.	Nie
sessionCount	Liczba sesji do zwrócenia w jednym żądaniu. Domyślnie: 1000, maksymalnie: 1000.	int32	Dowolna liczba całkowita od 0 do 1000	Nie
pageIndex	Numer strony sesji do zwrócenia (indeksowane od 0).	int32	Dowolna liczba całkowita ≥ 0	Nie

Uwagi:

Jeśli parametry czasowe nie zostaną określone:
- Jeśli start i end nie są podane, zwrócone zostaną wszystkie sesje z bazy danych.
- Jeśli start nie jest podany, zwrócone zostaną sesje rozpoczęte przed datą end.
- Jeśli end nie jest podany, zwrócone zostaną sesje rozpoczęte lub zakończone po dacie start.
Jeśli sesja rozpoczęła się przed datą start, za jej początek przyjmowana jest pierwsza aktywność po tej dacie.
Jeśli sesja zakończyła się po dacie end, za jej koniec przyjmowana jest ostatnia aktywność przed tą datą.

Odpowiedź (status 200 = sukces):

Zwracana jest lista sesji ze szczegółami:

Nazwa (typ)	Opis
duration (czas)	Czas trwania sesji
idleTime (czas)	Czas bezczynności użytkownika
productivityTime (czas)	Czas aktywnej pracy użytkownika
clientGuid (string)	GUID agenta monitorowania
clientName (string)	Nazwa agenta monitorowania
loginDate (data-czas)	Data i godzina rozpoczęcia sesji
logoutDate (data-czas)	Data i godzina zakończenia sesji
sessionId (int32)	ID sesji
userName (string)	Nazwa użytkownika
userId (int32)	ID użytkownika
totalCount (int32)	Łączna liczba sesji spełniających kryteria

Przykład odpowiedzi JSON:

{
  "sessions": [
    {
      "duration": "20:20:40.0020000",
      "idleTime": "12:57:42.3480000",
      "productivityTime": "07:22:57.6540000",
      "clientGuid": "5d4fe546-8aff-4510-a814-f6a8ee14effq",
      "clientName": "clientname1",
      "logoutDate": "2000-01-23T04:56:07.000+00:00",
      "loginDate": "2000-01-23T04:56:07.000+00:00",
      "sessionId": 613,
      "userName": "username1",
      "userId": 19
    },
    {
      "duration": "8:12:25.7950000",
      "idleTime": "11:55:42.3480000",
      "productivityTime": "11:22:66.6540000",
      "clientGuid": "qi4fe546-8aff-4513-a814-f6a8ee14effq",
      "clientName": "clientname2",
      "logoutDate": "2000-01-23T04:56:07.000+00:00",
      "loginDate": "2000-01-23T04:56:07.000+00:00",
      "sessionId": 16,
      "userName": "username2",
      "userId": 7
    }
  ],
  "totalCount": 4
}

Uwaga: Jeśli zażądana liczba sesji przekroczy 1000, zwracany będzie kod statusu HTTP 400.