User Productivity

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

[
  {
    "date": "2021-09-03T00:00:00+05:00",
    "totalMinutes": 25.816666666666666,
    "userName": "userName1",
    "timeOfDay": 18
  },
  {
    "date": "2020-02-03T00:00:00+03:00",
    "totalMinutes": 6,
    "userName": "userName2",
    "timeOfDay": 4
  }
]

Returns total active time (in minutes) for each user during each hour of each day. This is the canonical endpoint for user productivity dashboards — it aggregates across sessions and produces a clean (date, hour, user) → minutes shape ready for time-series visualizations.

GET https://<hostname>/ekranapi/user/getproductivity

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 in the productivity calculation.Accepted formats: 2021-04-01, 2021-04-01T12:00, 2021-04-01T12:00:00.

string

Sessions that were started or finished before this time are included.

If both start and end are omitted, productivity for all sessions in the database is returned. See Time parameter conventions for full rules and boundary clipping.

Response (200 OK)

date-time

The date (date portion is significant; time portion encodes UTC offset).

double

Total number of minutes the user was active during this hour of the day.

string

The user name.

int32

The hour of the day (0–23).

Example

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

[
  {
    "date": "2021-09-03T00:00:00+05:00",
    "totalMinutes": 25.816666666666666,
    "userName": "userName1",
    "timeOfDay": 18
  },
  {
    "date": "2020-02-03T00:00:00+03:00",
    "totalMinutes": 6,
    "userName": "userName2",
    "timeOfDay": 4
  }
]

For productivity heatmaps, group results by (userName, timeOfDay) across all dates in your range — the resulting matrix shows when each user is most active throughout the day. This is exactly the shape Power BI uses for the User Productivity report — see the Power BI example.

Errors

See Status codes. Common errors:

400 Bad Request — invalid start or end format.
403 Forbidden — Data Connector not registered.

List users

Get the full user list (use for filtering or display).

List sessions with productivity

Session-level productivity — duration, idle, productive time.

Application statistics

Per-application breakdown of where active time went.

Power BI example

The Power BI User Productivity report uses this endpoint.

Overview

Application Credentials Broker

Data Connector API

SSO & LDAP

SIEM & Ticketing systems

User Productivity

Authentication

Query parameters

Response (200 OK)

Example

Errors

List users

List sessions with productivity

Application statistics

Power BI example

​Authentication

​Query parameters

​Response (200 OK)

​Example

​Errors

​Related

List users

List sessions with productivity

Application statistics

Power BI example

Authentication

Query parameters

Response (200 OK)

Example

Errors

Related