API docs by Redocly

Controlio API (1.1)

Download OpenAPI specification:

This API provides you with access to the data stored in your account

Activities

Activities operations

Get activities

Retrieves the list of existing activities

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

parent_id
integer

ID of category in which queried items are nested

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get activity

Get a single activity by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": { },
  • "category_id": 0,
  • "custom_levels": [
    ],
  • "icon": { },
  • "level": 0,
  • "level_redefined": true,
  • "name": "string",
  • "type": 0,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Update activity

Method for updating existing activities

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Request Body schema: application/x-www-form-urlencoded
required
category_id
integer

ID of the new parent category in which the activity will be moved. If the activity productivity level not redefined it will be inherited from the new parent category.

level
integer
Enum: 0 1 2 3 4

New productivity level of the activity. Can be changed only if inheritance of level from the parent category is disabled. Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

level_redefined
boolean

Flag that defines whether the current activity productivity level is redefined or inherited from parent category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": { },
  • "category_id": 0,
  • "custom_levels": [
    ],
  • "icon": { },
  • "level": 0,
  • "level_redefined": true,
  • "name": "string",
  • "type": 0,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Categories

Categories operations

Get categories

Retrieves the list of existing categories in flat view

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

parent_id
integer

ID of category in which queried items are nested

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create category

Method for creating new categories

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Name of new category

parent_id
required
string

ID of the parent category in which the new category should be nested. 0 is for the root level category, which will contain other categories in the future.

level
integer
Enum: 0 1 2 3 4

Productivity level of the new category. This field is required when creating nested category, and not suporting during creation of the root level category. Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "custom_levels": [
    ],
  • "description": "string",
  • "is_default": true,
  • "level": 0,
  • "name": "string",
  • "parent_id": 0,
  • "parent_name": "string",
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Get category

Get a single category by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "custom_levels": [
    ],
  • "description": "string",
  • "is_default": true,
  • "level": 0,
  • "name": "string",
  • "parent_id": 0,
  • "parent_name": "string",
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Update category

Method for updating existing categories

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Request Body schema: application/x-www-form-urlencoded
required
parent_id
integer

ID of the new parent category in which the category will be moved.

level
integer
Enum: 0 1 2 3 4

New productivity level of the category. Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

name
string

New category name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "custom_levels": [
    ],
  • "description": "string",
  • "is_default": true,
  • "level": 0,
  • "name": "string",
  • "parent_id": 0,
  • "parent_name": "string",
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Delete category

Method for deleting categories. You cannot delete the default system categories. All nested activities will be moved Uncategorized category.

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}

Computers

Computers operations

Get computers

Retrieves the list of existing computers with the client agent program installed.

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get computer

Get a single computer by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "blocked": true,
  • "city": "string",
  • "client_category_version": "string",
  • "client_path": "string",
  • "client_version": "string",
  • "country": "string",
  • "country_code": 0,
  • "deleted": true,
  • "description": "string",
  • "friendly_name": "string",
  • "id": 0,
  • "install_guid": "string",
  • "ip": "string",
  • "last_connect_time": "string",
  • "last_upload_time": "string",
  • "name": "string",
  • "options_id": 0,
  • "options_inherited": true,
  • "os_version": "string",
  • "parent_id": 0,
  • "security_inherited": true,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Departments

Departments operations

Get departments

Retrieves the list of existing departments in flat view

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

parent_id
integer

ID of department in which queried items are nested

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create department

Method for creating new departments

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Name of new department

parent_id
required
string

ID of the parent department which the new department should be nested in

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ancestors": [
    ],
  • "ancestors_names": [
    ],
  • "name": "string",
  • "parent_id": 0,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Get department

Get a single department by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ancestors": [
    ],
  • "ancestors_names": [
    ],
  • "name": "string",
  • "parent_id": 0,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Update department

Method for updating existing departments

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Request Body schema: application/x-www-form-urlencoded
required
name
string

New name of the department

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ancestors": [
    ],
  • "ancestors_names": [
    ],
  • "name": "string",
  • "parent_id": 0,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Delete department

Method for deleting departments. You can delete only empty department so you need to move all nested objects.

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "result": "OK"
}

Move departments

Method for moving departments and manipulate units organization structure

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
departments
required
string

List of departments IDs to move, separated by commas

parent_id
required
string

ID of the parent department which the departments should be nested in

Responses

Response samples

Content type
application/json
{
  • "success": {
    },
  • "partial_success": {
    }
}

Logins

Logins operations

Get logins

Retrieves the list of existing logins

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get login

Get a single login by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "first_name": "string",
  • "ip": "string",
  • "last_name": "string",
  • "mfa": true,
  • "policy_id": 0,
  • "policy": { },
  • "related_users": [
    ],
  • "role": "owner",
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z",
  • "users": [
    ],
  • "departments": [
    ],
  • "verified": true
}

Rules

Rules operations

Get rules

Retrieves the list of behavior rules

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get rule

Get a single rule by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "deleted": true,
  • "departments": [
    ],
  • "departments_ex": [
    ],
  • "enabled": true,
  • "id": 0,
  • "name": "string",
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z",
  • "users": [
    ],
  • "users_ex": [
    ]
}

Users

Users operations

Get users

Retrieves the list of existing users

Authorizations:
BearerAuth
query Parameters
object or string

A key used for looking up records by matching keywords in default or given allowed keys

ids
Array of integers

List of ids to be returned as a response

parent_id
integer

ID of department in which queried items are nested

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get user

Get a single user by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "ancestors": [
    ],
  • "ancestors_names": [
    ],
  • "blocked": true,
  • "custom_options": { },
  • "deleted": true,
  • "description": "string",
  • "friendly_name": "string",
  • "id": 0,
  • "is_custom_options": true,
  • "last_connect_time": "string",
  • "last_upload_time": "string",
  • "login_id": 0,
  • "name": "string",
  • "nearest_options_id": 0,
  • "old_name": "string",
  • "options": { },
  • "options_id": 0,
  • "options_inherited": true,
  • "parent_id": 0,
  • "security_inherited": true,
  • "sync_friendly_name": true,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Update user

Method for updating existing users

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Request Body schema: application/x-www-form-urlencoded
required
friendly_name
string

New name of the user

blocked
boolean

Flag that defines whether the current user monitoring blocked or not

Responses

Response samples

Content type
application/json
{
  • "ancestors": [
    ],
  • "ancestors_names": [
    ],
  • "blocked": true,
  • "custom_options": { },
  • "deleted": true,
  • "description": "string",
  • "friendly_name": "string",
  • "id": 0,
  • "is_custom_options": true,
  • "last_connect_time": "string",
  • "last_upload_time": "string",
  • "login_id": 0,
  • "name": "string",
  • "nearest_options_id": 0,
  • "old_name": "string",
  • "options": { },
  • "options_id": 0,
  • "options_inherited": true,
  • "parent_id": 0,
  • "security_inherited": true,
  • "sync_friendly_name": true,
  • "inserted_at": "2020-10-22T20:53:11.877501Z",
  • "updated_at": "2020-10-22T20:53:11.877501Z"
}

Move users

Method for moving users between departments and manipulate units organization structure

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
users
required
string

List of users IDs to move, separated by commas

parent_id
required
string

ID of the the parent department in which the users should be nested

Responses

Response samples

Content type
application/json
{
  • "success": {
    },
  • "partial_success": {
    }
}

Audit log

Low level events log records

Get audit log

Retrieves the audit log

Authorizations:
BearerAuth
query Parameters
object_types
Array of strings
Items Enum: "login" "page" "user" "department" "computer" "activity" "category" "options" "rule" "scheduled_report" "account" "video_export_task" "live_stream" "policy" "report" "tour" "personal_token" "client_agent"
Example: object_types=login,policy

Filters audit log entries by one or more object types to which the action was applied. Case-sensitive. Comma-separated list. When omitted, entries for all object types are included.

api_types
Array of strings
Items Enum: "rest" "rpc"
Example: api_types=rest,rpc

Filters audit log entries by one or more API interfaces through which events were initiated. Case-sensitive. Comma-separated list. When omitted, all interfaces are included. Allowed values:

  • rest — events initiated via the public REST API.
  • rpc — events triggered by actions in the dashboard (Browser).
actions
Array of strings
Items Enum: "view" "create" "update" "delete" "move" "clear" "logon" "logon_failed" "logoff" "change_password" "recover_password" "reset_password" "invite" "enable_mfa" "disable_mfa" "uninstall" "start_tour" "change_password_failed" "reset_password_failed" "logon_failed_blocked" "unblock" "login_blocked" "export_csv" "export_pdf" "win_client_update" "mac_client_update" "update_smtp_settings" "update_security_settings" "download" "sso.saml.successfull_login" "sso.saml.login_attempt"
Example: actions=update,download

Filters audit log entries by one or more actions. Case-sensitive. Comma-separated list. When omitted, all actions are included.

logins
Array of integers <int64> [ items <int64 > >= 1 ]
Example: logins=123,456,789

Filters audit log entries by one or more IDs of the logins that performed the action. Comma-separated list. When omitted, entries from all logins are included. If the specified IDs do not exist, an empty result is returned.

emails
Array of strings <email> [ items <email > ]
Example: emails=alice@example.com,bob@example.com

Filters audit log entries by one or more emails of the logins that performed the action. Comma-separated list. When omitted, entries from all logins are included. If both logins and emails are provided, logins takes precedence and this filter is ignored. If the specified emails do not exist, an empty result is returned.

object_id
integer <int64> >= 1
Example: object_id=123456

Filters audit log entries by the ID of the affected object. It is recommended to use together with object_type to avoid ambiguity. If the specified ID does not exist, an empty result is returned.

apply_timezone
boolean
Default: false
Example: apply_timezone=true

When true, interprets time-based filters in the account's timezone (e.g., time range parameters start_date and end_date). This affects filtering only; timestamps in the response remain UTC. When false, filtering is performed in UTC.

ip
string

The IPv4 of a login who called an action

start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Sessions report

Activity sessions report

Get Sessions - Activity report

Get the activity sessions report

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

aggregate_by_user
boolean
Default: false

If true, user sessions on all computers will be aggregated.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activities report

Activities report

Get activities report

Get the statistics activities report

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Alerts report

Alerts report

Get Alerts report

Get the behavior alerts report

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Captions report

Captions report

Get Captions by Activity report

Get the captions by activity report. This is each windowed instance that appears during a concrete activity

Authorizations:
BearerAuth
query Parameters
activity_id
required
integer

ID of the activity which windows you want to see

start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Categories report

Categories report

Get Categories report

Get the categories report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detailed files report

Detailed files report

Get Detailed Files report

Get the detailed files report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

removable_only
boolean
Default: false

Show only operations from/to removable devices.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detailed activities report

Detailed activities report

Get Detailed Activities report

Get the detailed activities report. Always sorted by start_time. Since this is a low level raw data report and can contain huge amounts of data - it uses another approach to get chunked data instead of classic offset. See prev parameter description.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

prev
string

Composite key to specify a unique index of the previous record from which the next chunk of data will be received. Consists start_time, user_id and computer_id, separated by commas

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Emails report

Emails report

Get Emails report

Get the emails report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get email

Get a single email by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "attachments": {
    },
  • "computer_id": 0,
  • "direction": 0,
  • "from_address": "string",
  • "id": 0,
  • "message": "string",
  • "protocol": "string",
  • "subject": "string",
  • "time": "string",
  • "to_address": [
    ],
  • "user_id": 0
}

Keystrokes report

Keystrokes report

Get Keystrokes report

Get the keystrokes report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Printing report

Printing report

Get Printing report

Get the printing report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Productivity report

Productivity report

Get Productivity report

Get the productivity report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Searches report

Searches report

Get Searches report

Get the searches report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Sessions - Logons report

Sessions - Logons report

Get Sessions - Logons report

Get the logons report.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

offset
integer
Default: 0

the number of records that need to be skipped

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timeline Report

Low level-data users activities report

Get Timeline report

Get users activities raw timeline report. Always sorted by start_time. Since this is a low level raw data report and can contain huge amounts of data - it uses another approach to get chunked data instead of classic offset. See prev parameter description.

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

limit
integer
Default: 10000

the number of records in list per request

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

prev
string

Composite key to specify a unique index of the previous record from which the next chunk of data will be received. Consists start_time, user_id and computer_id, separated by commas

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Users Activities report

Users Activities report

Get users activities

Retrieves the list of users activities

Authorizations:
BearerAuth
query Parameters
limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Users report

Users report

Get users productivity report

Get the users productivity report

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

string_to_match
string

A key used for looking up records by matching keywords in default or given allowed keys.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Workload

Get workload report by users

Get the workload report grouped by users

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get workload report by days

Get the workload report grouped by days

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

user_id
integer

Id of user.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get workload report by departments

Get the workload report grouped by departments

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Operations

Get operations report by users

Get the operations report grouped by users

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

weekdays
Array of integers
Items Enum: 0 1 2 3 4 5 6
Example: weekdays=1,3,5

Comma-separated string of weekdays (integers from 0 to 6, where 0 = Sunday, 1 = Monday, …, 6 = Saturday) used to filter report data.

hours
Array of integers
Items Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Example: hours=0,7,19,23

Comma-separated string of hours (integers from 0 to 23) used to filter report data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

computers
string
Default: null
Example: computers=1,2,3,4,5

List of computers ids for whom you want to gather report data in format of comma separated integers

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

categories
string
Default: null
Example: categories=1,2,3,4,5

List of categories ids for whom you want to gather report data in format of comma separated integers

object or string

A key used for looking up records by matching keywords in default or given allowed keys

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get operations report by days

Get the operations report grouped by days

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

weekdays
Array of integers
Items Enum: 0 1 2 3 4 5 6
Example: weekdays=1,3,5

Comma-separated string of weekdays (integers from 0 to 6, where 0 = Sunday, 1 = Monday, …, 6 = Saturday) used to filter report data.

hours
Array of integers
Items Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Example: hours=0,7,19,23

Comma-separated string of hours (integers from 0 to 23) used to filter report data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

computers
string
Default: null
Example: computers=1,2,3,4,5

List of computers ids for whom you want to gather report data in format of comma separated integers

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

categories
string
Default: null
Example: categories=1,2,3,4,5

List of categories ids for whom you want to gather report data in format of comma separated integers

object or string

A key used for looking up records by matching keywords in default or given allowed keys

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Multitasking

Get multitasking report by users

Get the multitasking report grouped by users

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

weekdays
Array of integers
Items Enum: 0 1 2 3 4 5 6
Example: weekdays=1,3,5

Comma-separated string of weekdays (integers from 0 to 6, where 0 = Sunday, 1 = Monday, …, 6 = Saturday) used to filter report data.

hours
Array of integers
Items Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Example: hours=0,7,19,23

Comma-separated string of hours (integers from 0 to 23) used to filter report data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

computers
string
Default: null
Example: computers=1,2,3,4,5

List of computers ids for whom you want to gather report data in format of comma separated integers

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

categories
string
Default: null
Example: categories=1,2,3,4,5

List of categories ids for whom you want to gather report data in format of comma separated integers

object or string

A key used for looking up records by matching keywords in default or given allowed keys

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get multitasking report by days

Get the multitasking report grouped by days

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

weekdays
Array of integers
Items Enum: 0 1 2 3 4 5 6
Example: weekdays=1,3,5

Comma-separated string of weekdays (integers from 0 to 6, where 0 = Sunday, 1 = Monday, …, 6 = Saturday) used to filter report data.

hours
Array of integers
Items Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Example: hours=0,7,19,23

Comma-separated string of hours (integers from 0 to 23) used to filter report data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

computers
string
Default: null
Example: computers=1,2,3,4,5

List of computers ids for whom you want to gather report data in format of comma separated integers

activities
string

List of activities ids for whom you want to gather report data in format of comma separated integers

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

level
integer
Enum: 0 1 2 3 4

Productivity level - 0 for Very distracting, 1 for Distracting, 2 for Neutral, 3 for Productive, 4 for Very productive

categories
string
Default: null
Example: categories=1,2,3,4,5

List of categories ids for whom you want to gather report data in format of comma separated integers

object or string

A key used for looking up records by matching keywords in default or given allowed keys

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Categories distribution

Get categories distribution report by users

Get the categories distribution report grouped by users

Authorizations:
BearerAuth
query Parameters
start_time
string

Date in YYYY-MM-DD format. Sets the beginning of the date range for collected data.

end_time
string

Date in YYYY-MM-DD format. Sets the end of the date range for collected data.

weekdays
Array of integers
Items Enum: 0 1 2 3 4 5 6
Example: weekdays=1,3,5

Comma-separated string of weekdays (integers from 0 to 6, where 0 = Sunday, 1 = Monday, …, 6 = Saturday) used to filter report data.

hours
Array of integers
Items Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Example: hours=0,7,19,23

Comma-separated string of hours (integers from 0 to 23) used to filter report data.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

computers
string
Default: null
Example: computers=1,2,3,4,5

List of computers ids for whom you want to gather report data in format of comma separated integers

activity_type
integer
Enum: 0 1 2

Type of activity - 0 for Applications, 1 for websites, pass 2 or don't specify this parameter for both activity types.

categories
string
Default: null
Example: categories=1,2,3,4,5

List of categories ids for whom you want to gather report data in format of comma separated integers

limit
integer
Default: 10000

the number of records in list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Summary Report

Timeline summary report

Get timeline summary report

Get the timeline summary report

Authorizations:
BearerAuth
query Parameters
start_time
required
string

Date in YYYY-MM-DD. Sets the day for which data is collected.

interval
integer
Default: 30
Enum: 5 15 30 60

interval for timeline data aggregation

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 25

the number of records in the list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get timeline summary by user report

Get the timeline summary report for a single user

Authorizations:
BearerAuth
path Parameters
user_id
required
integer

Id of user.

query Parameters
start_time
required
string

Date in format YYYY-MM-DD. Sets the first day of the range to gather data.

end_time
required
string

Date in format YYYY-MM-DD. Sets the last day of the range to gather data.

interval
integer
Default: 30
Enum: 5 15 30 60

interval for timeline data aggregation

limit
integer
Default: 25

the number of records in the list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

RAW Report

Timeline RAW report

Get timeline RAW report

Get the timeline RAW report

Authorizations:
BearerAuth
query Parameters
start_time
required
string

Date in format YYYY-MM-DD. Sets the day for which data is gathered.

users
string

List of users ids for whom you want to collect report data in the format of comma-separated integers.

departments
string

List of departments ids for which you want to collect report data in the format of comma-separated integers.

limit
integer
Default: 25

the number of records in the list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get RAW timeline by user report

Get the timeline RAW report for a single user.

Authorizations:
BearerAuth
path Parameters
user_id
required
integer

Id of user.

query Parameters
start_time
required
string

Date in format YYYY-MM-DD. Sets the first day of the range to gather data.

end_time
required
string

Date in format YYYY-MM-DD. Sets the last day of the range to gather data.

limit
integer
Default: 25

the number of records in the list per request

offset
integer
Default: 0

the number of records that need to be skipped

sort_direction
string
Default: "desc"
Enum: "asc" "desc"

a key that dictates the sort order of the list

sort_by
string

a key that dictates the sequence of the list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}