Activtrak

Introduction

API Access

Reports

Working Hours

Activity Log

Administration

SCIM

Clients

Consumers

Bulk Import

Import user data

ActivTrak Admin API

ActivTrak Public APIs

Production

<p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s API Reference provides a set of endpoints for accessing your digital activity reports and for administering your ActivTrak instance. It allows users to see their and their team&apos;s aggregate and detailed activity data. Moreover, admins may be able manage their users and groups. The ActivTrak API Reference Guide provides developers with the information needed to integrate ActivTrak into their own applications, allowing them to offer their users a secure and seamless experience.</p><p class="slate-p" placeholder="Type / for widgets">The ActivTrak API Reference Guide provides detailed information on each endpoint, including request and response formats, authentication methods, and sample code snippets in multiple programming languages. It also includes information on error handling and troubleshooting.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's API Reference provides a set of endpoints for accessing your digital activity reports and for administering your ActivTrak instance. It allows users to see their and their team's aggregate and detailed activity data. Moreover, admins may be able manage their users and groups. The ActivTrak API Reference Guide provides developers with the information needed to integrate ActivTrak into their own applications, allowing them to offer their users a secure and seamless experience.

The ActivTrak API Reference Guide provides detailed information on each endpoint, including request and response formats, authentication methods, and sample code snippets in multiple programming languages. It also includes information on error handling and troubleshooting.

API keys are unique alphanumeric values used to identify the application that is making the API request. API keys enable you to authorize your data requests so you can control access to your data at any time.

The features that you can access through your API keys are determined by your subscription plan as well as add-on. 

API keys may be created by your ActivTrak administrator from the ActivTrak app

From the navigation, select API & Integrations > API Keys, your ActivTrak admin will be able to find all keys that are created for the account. The table found on this page allows you to do the following operations for each API key

To authorize your API request using your API keys, set the header as indicated below, where “{apiKey}” is your API key.

<p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(0, 0, 0)" class="slate-color">ActivTrak&apos;s Reports APIs (also known as Live Data API) are REST APIs that allow querying data from reports in ActivTrak. This data is available at the same rate as what is accessible from the ActivTrak Web Application. Data should appear near real-time depending on when we receive data from installed Agents.</span></p><p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(0, 0, 0)" class="slate-color"><strong style="color:rgb(0, 0, 0)" class="slate-bold">Note:</strong></span><span style="color:rgb(0, 0, 0)" class="slate-color"> The Reports APIs currently support:</span></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><a href="https://support.activtrak.com/hc/en-us/articles/360035258771-Working-Hours-Report" target="_self">Working Hours</a></div></li><li class="slate-li"><div style="position:relative"><a href="https://support.activtrak.com/hc/en-us/articles/360032795191-Activity-Log" target="_self">Activity Log</a></div></li></ul><p class="slate-p" placeholder="Type / for widgets">Auth is mapped to a specific customer account and web user. The permissions that dictate the available data are driven by the permissions for the user associated with the API key. For more information about getting access please see the <a href="https://developers.activtrak.com/introduction/api-access" target="_self">API Access</a> section.</p><p class="slate-p" placeholder="Type / for widgets">The Reports APIs currently has two forms of pagination. The original is the older page-style pagination. The newer is cursor-based pagination. For the time being, the Working Hours Report must use page-based pagination, and the Activity Log must use cursor-based pagination. In the future, the plan is to move everything over to cursor-based pagination at which time the page-based requests will be deprecated.</p><p class="slate-p" placeholder="Type / for widgets">For assistance, please contact support@activtrak.com. </p><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's Reports APIs (also known as Live Data API) are REST APIs that allow querying data from reports in ActivTrak. This data is available at the same rate as what is accessible from the ActivTrak Web Application. Data should appear near real-time depending on when we receive data from installed Agents.

Auth is mapped to a specific customer account and web user. The permissions that dictate the available data are driven by the permissions for the user associated with the API key. For more information about getting access please see the 

The Reports APIs currently has two forms of pagination. The original is the older page-style pagination. The newer is cursor-based pagination. For the time being, the Working Hours Report must use page-based pagination, and the Activity Log must use cursor-based pagination. In the future, the plan is to move everything over to cursor-based pagination at which time the page-based requests will be deprecated.

For assistance, please contact support@activtrak.com. 

<p class="slate-p" placeholder="Type / for widgets">The Working Hours endpoints return data that corresponds to the data displayed in ActivTrak app&apos;s Working Hours report under Live Reports. The Working Hours report is designed to quickly show a user&apos;s first and last activity for each day and give an overview of their daily activity. For more information about this report see this <a href="https://support.activtrak.com/hc/en-us/articles/360035258771-Working-Hours-Report" target="_self">article</a> on Help Center</p><p class="slate-p" placeholder="Type / for widgets"></p>

The Working Hours endpoints return data that corresponds to the data displayed in ActivTrak app's Working Hours report under Live Reports. The Working Hours report is designed to quickly show a user's first and last activity for each day and give an overview of their daily activity. For more information about this report see this 

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">This API call returns a list of Working Hour Activity objects along with a total (used for pagination). This data is from the user&apos;s perspective.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This API call returns a list of Working Hour Activity objects along with a total (used for pagination). This data is from the user's perspective.

Get working hours for users

x-api-key

from

The end date (inclusive). Format: YYYY-MM-DD.

The specific client Id to fetch data. The default value of -1 returns data "all users". Only one of the fields(clientId, groupId, deviceId) can be sent per request.

clientId

The specific group Id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request.

groupId

page

The page size for the number of results to return per request. The maximum value is 1000.

pageSize

activity

total

Bad request. Failed with an error message indicating the reason of the failure.

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">This API call returns a list of Working Hour Activity objects along with a total (used for pagination). This data will be from the computer perspective.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This API call returns a list of Working Hour Activity objects along with a total (used for pagination). This data will be from the computer perspective.

Get working hours for computers

The specific device id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request.

deviceId

A response with the Report for Computers.

Bad request. Failed StatusResponse with an error message indicating the reason of the failure.

<p class="slate-p" placeholder="Type / for widgets">The Activity Log endpoint returns data that corresponds to the data displayed in ActivTrak app&apos;s Activity Log report under Live Reports. The Activity Log is the master record of all digital activity and time spent by your team. For more information about this report see this <a href="https://support.activtrak.com/hc/en-us/articles/360032795191-Activity-Log" target="_self">article</a> on Help Center</p><p class="slate-p" placeholder="Type / for widgets"></p>

The Activity Log endpoint returns data that corresponds to the data displayed in ActivTrak app's Activity Log report under Live Reports. The Activity Log is the master record of all digital activity and time spent by your team. For more information about this report see this 

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">This API call returns a list of Activity Log objects</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This API call returns a list of Activity Log objects

Get activity log

The starting date. Format: YYYY-MM-DD. If a cursor is provided for pagination, this field does not affect your query results. The default value is {TODAY}

startDate

The end date (inclusive). Format: YYYY-MM-DD. This field should only be used to bind your data to a specific date range. Otherwise, you only require the start date and you can paginate through to all available data from that point.

endDate

The specific client id to fetch data. The default value of -1 returns data "all users" Only one of the fields (clientId, groupId, deviceId) can be sent per request

The specific device id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request

The specific group id to fetch data. Only one of the fields (clientId, groupId, deviceId) can be sent per request

The page size for number of results to return per request. The maximum value is 1000. The default value is 150.

The cursor for pagination. When a request is made without a cursor, the response returns results based on the date range. Each response returns a cursor. You should input the new cursor value for each subsequent request if you wish to paginate through additional data. If you do provide a cursor, the startDate no longer affects the result boundaries. This allows you to receive old records that have arrived late. If you receive no results with a valid/provided cursor, it means that no new records have been received yet. A cursor request which returns no results will return the same cursor back to the caller.

cursor

The minimum duration in seconds (inclusive). Only activities that have a duration greater than or equal to this value will be returned.

minDuration

The maximum duration in seconds (inclusive). Only activities that have a duration less than or equal to this value will be returned.

maxDuration

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">ActivTrak&apos;s Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"><strong class="slate-bold">Note</strong>: The Administration APIs initially support:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:#FE0000" class="slate-color"><strong style="color:#FE0000" class="slate-bold">NEW!</strong></span> API for ActivTrak&apos;s next generation user and group management</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Currently in testing and will be released soon in BETA!</div></li></ul></li><li class="slate-li"><div style="position:relative">Legacy: Retrieval of user agent (ie client) information</div></li></ul><p class="slate-p" placeholder="Type / for widgets">For more information about getting access please see the <a href="https://developers.activtrak.com/activtrak-public-apis/introduction/api-access" target="_self">API Access</a> section.</p><p class="slate-p" placeholder="Type / for widgets">Please contact integrations-feedback@activtrak.com for questions and/or feedback.</p><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.

: The Administration APIs initially support:

For more information about getting access please see the 

Please contact integrations-feedback@activtrak.com for questions and/or feedback.

<p class="slate-p" placeholder="Type / for widgets">This is the API for ActivTrak&apos;s next-gen user management based on SCIM. <strong class="slate-bold">The endpoints are available in BETA.</strong></p><p class="slate-p" placeholder="Type / for widgets">For more information about System for Cross-domain Identity Management (SCIM), see <a href="https://scim.cloud/">https://scim.cloud/</a></p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Authentication</h2><p class="slate-p" placeholder="Type / for widgets">A special-use API key is required to use this API. Please reach out to <a href="mailto:integrations-feedback@activtrak.com" target="">integrations-feedback@activtrak.com</a> to obtain one.</p><p class="slate-p" placeholder="Type / for widgets"></p>

This is the API for ActivTrak's next-gen user management based on SCIM. 

For more information about System for Cross-domain Identity Management (SCIM), see 

A special-use API key is required to use this API. Please reach out to 

<p class="slate-p" placeholder="Type / for widgets">Returns the API&apos;s uptime status.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Ping

Returns the message "Pong" indicating successful API ping.

<p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s SCIM API supports the retrieval of supported SCIM schemas.</p><p class="slate-p" placeholder="Type / for widgets">The following schemas are supported:</p><h3 class="slate-h3">Core</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:core:2.0:User</div></li><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:core:2.0:Group</div></li></ul><h3 class="slate-h3">Enterprise</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:extension:enterprise:2.0:User</div></li></ul><h3 class="slate-h3">Custom</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:extension:activtrak:2.0:SourceType</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's SCIM API supports the retrieval of supported SCIM schemas.

Schemas

<p class="slate-p" placeholder="Type / for widgets">Returns a list of supported SCIM schemas.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Returns a list of supported SCIM schemas.

Get Schemas

schemas

totalResults

resources

<p class="slate-p" placeholder="Type / for widgets">Returns a specified SCIM schema by URI.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get Schema

schemaUri

name

description

attributes

<p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s SCIM API supports the retrieval, creation, update, and deletion of User entities.</p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Supported Fields</h2><p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s SCIM API supports the following User fields:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">id</div></li><li class="slate-li"><div style="position:relative">username</div></li><li class="slate-li"><div style="position:relative">name</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">familyName</div></li><li class="slate-li"><div style="position:relative">givenName</div></li><li class="slate-li"><div style="position:relative">middleName</div></li></ul></li><li class="slate-li"><div style="position:relative">displayName</div></li><li class="slate-li"><div style="position:relative">emails</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">primary</div></li><li class="slate-li"><div style="position:relative">value</div></li></ul></li><li class="slate-li"><div style="position:relative">groups</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">value</div></li><li class="slate-li"><div style="position:relative">display</div></li><li class="slate-li"><div style="position:relative">$ref</div></li><li class="slate-li"><div style="position:relative">type</div></li></ul></li><li class="slate-li"><div style="position:relative">meta</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">resourceType</div></li><li class="slate-li"><div style="position:relative">created</div></li><li class="slate-li"><div style="position:relative">lastModified</div></li><li class="slate-li"><div style="position:relative">location</div></li><li class="slate-li"><div style="position:relative">version</div></li></ul></li><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumber</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's SCIM API supports the retrieval, creation, update, and deletion of User entities.

ActivTrak's SCIM API supports the following User fields:

Users

<p class="slate-p" placeholder="Type / for widgets">Returns a list of ActivTrak Users.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get Users

<p class="slate-p" placeholder="Type / for widgets">Returns a filtered list of ActivTrak Users.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Returns a filtered list of ActivTrak Users.

Get Users by Filter

filter

<p class="slate-p" placeholder="Type / for widgets">Returns a single ActivTrak User by ID.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get User

userId

userName

displayName

emails

groups

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

<p class="slate-p" placeholder="Type / for widgets">Creates a new ActivTrak User.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Create User

Content-Type

<p class="slate-p" placeholder="Type / for widgets">Updates an existing ActivTrak User by replacing it with the provided entity.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Updates an existing ActivTrak User by replacing it with the provided entity.

Update User

<p class="slate-p" placeholder="Type / for widgets">Updates an existing ActivTrak User by performing specified Patch operations.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Updates an existing ActivTrak User by performing specified Patch operations.

Patch User (update Display Name)

operations

Patch User (Add Email)

Patch User (Remove Email)

<p class="slate-p" placeholder="Type / for widgets">Adds an ActivTrak User to the Do Not Track list and deletes their associated user agents.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Adds an ActivTrak User to the Do Not Track list and deletes their associated user agents.

Delete User

<p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s SCIM API supports the retrieval, creation, update, and deletion of User Groups.</p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Supported Fields</h2><p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s SCIM API supports the following Group fields:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">id</div></li><li class="slate-li"><div style="position:relative">displayName</div></li><li class="slate-li"><div style="position:relative">members</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">value</div></li><li class="slate-li"><div style="position:relative">display</div></li><li class="slate-li"><div style="position:relative">$ref</div></li><li class="slate-li"><div style="position:relative">type</div></li></ul></li><li class="slate-li"><div style="position:relative">meta</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">resourceType</div></li><li class="slate-li"><div style="position:relative">created</div></li><li class="slate-li"><div style="position:relative">lastModified</div></li><li class="slate-li"><div style="position:relative">location</div></li><li class="slate-li"><div style="position:relative">version</div></li></ul></li><li class="slate-li"><div style="position:relative">urn:ietf:params:scim:schemas:extension:activtrak:2.0:SourceType.sourceType</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's SCIM API supports the retrieval, creation, update, and deletion of User Groups.

ActivTrak's SCIM API supports the following Group fields:

Groups

<p class="slate-p" placeholder="Type / for widgets">Returns a list of ActivTrak Groups.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get Groups

<p class="slate-p" placeholder="Type / for widgets">Returns a filtered list of ActivTrak Groups.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Returns a filtered list of ActivTrak Groups.

Get Groups by Filter

<p class="slate-p" placeholder="Type / for widgets">Returns a single ActivTrak Group by ID.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get Group

members

urn:ietf:params:scim:schemas:extension:activtrak:2.0:SourceType

<p class="slate-p" placeholder="Type / for widgets">Creates a new ActivTrak Group.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Create Group

<p class="slate-p" placeholder="Type / for widgets">API Controller for SCIM User and Group Identity Management operations</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

API Controller for SCIM User and Group Identity Management operations

Update Group

<p class="slate-p" placeholder="Type / for widgets">Updates an existing ActivTrak Group by performing specified Patch operations.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Updates an existing ActivTrak Group by performing specified Patch operations.

Patch Group (rename Group)

Patch Group (Add Members)

Patch Group (Remove Members)

<p class="slate-p" placeholder="Type / for widgets">Deletes an ActivTrak Group.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Delete Group

<p class="slate-p" placeholder="Type / for widgets">ActivTrak&apos;s Clients API enables multiple actions on clients within an account. Clients are users whose activity are being logged within the ActivTrak system. Initially, this API supports retrieval of all users in an account.</p><p class="slate-p" placeholder="Type / for widgets"></p>

ActivTrak's Clients API enables multiple actions on clients within an account. Clients are users whose activity are being logged within the ActivTrak system. Initially, this API supports retrieval of all users in an account.

<p class="slate-p" placeholder="Type / for widgets">This API call returns a paged list of <code class="slate-code">Clients</code>. It returns the first page with up to 50 clients.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

. It returns the first page with up to 50 clients.

Get all clients

The ActivTrak ID number of a user agent. The first user agent in an organization starts at 1 and then increases sequentially.

The logon domain on which the user agent’s unique activity was identified.

domain

The name of a user that is derived from a computer’s user profile (user ID).

The alias that was previously provided for the user.

alias

Returns a paged list of clients for the account.

messages

success

Bad Request. Failed StatusResponse with an error message indicating the reason of the failure, and success equal to false.

<p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(0, 0, 0)" class="slate-color">ActivTrak&apos;s Consumers API enables multiple actions on consumers within an account. Consumers are defined as users of the ActivTrak app. Initially, this API supports retrieval of consumers in an account.</span></p><p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(0, 0, 0)" class="slate-color"></span></p>

ActivTrak's Consumers API enables multiple actions on consumers within an account. Consumers are defined as users of the ActivTrak app. Initially, this API supports retrieval of consumers in an account.

<p class="slate-p" placeholder="Type / for widgets">Returns a <code class="slate-code">Consumer</code>. If the consumer is not found, a StatusResponse object is returned indicating the error.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

. If the consumer is not found, a StatusResponse object is returned indicating the error.

Get consumer

The ID of an existing consumer whose information will be returned.

firstName

lastName

username

email

Assigned ActivTrak app role to the consumer

role

ssoEnabled

viewableGroups

Consumer's setting to view all groups. True if they can view all groups

allViewableGroups

Consumer's setting to set goals for all groups. True if they can set goals to all groups.

allGoalSetters

The consumer's data object that matches the id.

Failed StatusResponse with an error message indicating that the consumer couldn't be found.

<p class="slate-p" placeholder="Type / for widgets">Returns a paged list of <code class="slate-code">Consumers</code>. If no parameters are provided it returns the first page with up to 50 consumers.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

. If no parameters are provided it returns the first page with up to 50 consumers.

Get all consumers

The current page to get elements. Must be a positive number. If not provided, default value is 1

Page

The maximum number of elements to retrieve up to an upper limit. Must be a positive number. If no provided, default is the upper limit.

PageSize

results

A page of consumers and the total number of consumers.