List Sessions

curl -X GET "https://<hostname>/ekranapi/sessions?start=2021-04-01&end=2021-04-30" \
  -H "ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………"

[
  {
    "clientGuid": "1d4fegdr-g3ff-4114-a814-f3aeee14dgdg",
    "logoutDate": "2000-01-23T04:56:07.000+00:00",
    "loginDate": "2000-01-23T04:56:07.000+00:00",
    "sessionId": 124,
    "userId": 61
  },
  {
    "clientGuid": "dd4lwdr-xxff-4ss4-a814-f3aeee14dgdsg",
    "logoutDate": "2000-01-23T04:56:07.000+00:00",
    "loginDate": "2000-01-23T04:56:07.000+00:00",
    "sessionId": 142,
    "userId": 16
  }
]

Returns a list of Syteca Client sessions filtered by optional start and end time parameters. Returns basic session info — Client GUID, session ID, user ID, login and logout dates. For sessions with productivity details (duration, idle time, productive time) and pagination support, use POST /sessions instead.

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

Authentication

string

required

Your Active API Key from the Management Tool. See Manage → Get an API key.

Query parameters

string

Sessions that were started or finished after this time are included.Accepted formats: 2021-04-01, 2021-04-01T12:00, 2021-04-01T12:00:00. See Time parameter conventions.

string

Sessions that were started or finished before this time are included.Accepted formats: 2021-04-01, 2021-04-01T12:00, 2021-04-01T12:00:00.

If both start and end are omitted, all sessions in the database are returned. Sessions that span the start or end boundary are clipped — first activity after start becomes the session start, last activity before end becomes the session end. See Time parameter conventions for full rules.

Response (200 OK)

string

The GUID of the Client where the session was recorded.

When the session started (ISO 8601).

date-time

When the session ended (ISO 8601).

int32

The ID of the session.

int32

The ID of the user who was logged in during the session.

Example

curl -X GET "https://<hostname>/ekranapi/sessions?start=2021-04-01&end=2021-04-30" \
  -H "ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………"

[
  {
    "clientGuid": "1d4fegdr-g3ff-4114-a814-f3aeee14dgdg",
    "logoutDate": "2000-01-23T04:56:07.000+00:00",
    "loginDate": "2000-01-23T04:56:07.000+00:00",
    "sessionId": 124,
    "userId": 61
  },
  {
    "clientGuid": "dd4lwdr-xxff-4ss4-a814-f3aeee14dgdsg",
    "logoutDate": "2000-01-23T04:56:07.000+00:00",
    "loginDate": "2000-01-23T04:56:07.000+00:00",
    "sessionId": 142,
    "userId": 16
  }
]

Errors

See Status codes. Common errors:

400 Bad Request — invalid start or end format. Use one of the three accepted ISO formats.
403 Forbidden — the Data Connector is not registered. See Deactivate.
503 Service Unavailable — the Application Server is stopped.

List sessions with productivity (POST)

Same endpoint, POST method — returns duration, idle time, productive time, plus pagination.

List Clients

Look up Client GUIDs returned by this endpoint.

List users

Look up user IDs returned by this endpoint.

API reference

Base URL, authentication, status codes.

Overview

Application Credentials Broker

Data Connector API

SSO & LDAP

SIEM & Ticketing systems

Authentication

Query parameters

Response (200 OK)

Example

Errors

List sessions with productivity (POST)

List Clients

List users

API reference

​Authentication

​Query parameters

​Response (200 OK)

​Example

​Errors

​Related

List sessions with productivity (POST)

List Clients

List users

API reference

Authentication

Query parameters

Response (200 OK)

Example

Errors

Related