List Sessions with Productivity

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

{
  "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
}

Returns sessions with detailed productivity information — duration, idle time, productive time, plus the user name and Client name in the response. Paginated with up to 1000 sessions per request. This is the endpoint to use for productivity dashboards and time-tracking analytics.

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

Authentication

string

required

Your Active API Key from the Management Tool.

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.

int32

default:"1000"

Number of sessions to return per request.Default: 1000. Maximum: 1000.

int32

default:"0"

Page index for pagination — starts at 0. Use this to retrieve the next 1000 sessions after the first request.

Requesting more than 1000 sessions (sessionCount > 1000) returns HTTP 400 Bad Request.

If both start and end are omitted, all sessions in the database are returned (subject to pagination). See Time parameter conventions for boundary clipping rules.

Response (200 OK)

array

Array of session objects with the following per-session fields:

Show Session object

timespan

Total duration of the session — format hh:mm:ss.fffffff.

timespan

Total time the user was not active.

timespan

Total time the user was active.

string

The GUID of the Client.

string

The display name of the Client.

When the session started.

date-time

When the session ended.

int32

The ID of the session.

string

The user name.

int32

The ID of the user.

int32

Total number of sessions matching the filter (across all pages — useful for displaying “1–1000 of N” in your UI).

Example

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

{
  "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
}

Errors

See Status codes. Common errors:

400 Bad Request — invalid time format, or sessionCount > 1000.
403 Forbidden — Data Connector not registered. See Deactivate.

List sessions (GET)

Same endpoint, GET method — returns basic info only, no productivity, no pagination.

User productivity

Aggregate productivity across users, by hour of day.

Power BI example

The Power BI use case calls this endpoint to populate productivity dashboards.

API reference

Base URL, authentication, status codes, time parameters.

Overview

Application Credentials Broker

Data Connector API

SSO & LDAP

SIEM & Ticketing systems

List Sessions with Productivity

Authentication

Query parameters

Response (200 OK)

Example

Errors

List sessions (GET)

User productivity

Power BI example

API reference

​Authentication

​Query parameters

​Response (200 OK)

​Example

​Errors

​Related

List sessions (GET)

User productivity

Power BI example

API reference

Authentication

Query parameters

Response (200 OK)

Example

Errors

Related