Activtrak

Introduction

Reports

Overview

Working Hours

Activity Log

Administration

SCIM

Clients

Consumers

Bulk Import

Import user data

ActivTrak Admin API

ActivTrak Public APIs

Production

Production AU

Production CA

Production EU

Production UK

Create consumers

Create Group

Create User

Delete consumers

Delete Group

Delete User

Get activity log

Get all clients

Get all consumers

Get consumer

Get Group

Get Groups

Get Groups by Filter

Get Schema

Get Schemas

Get User

Get Users

Get Users by Filter

Get working hours for computers

Get working hours for users

Groups

Patch consumers

Patch Group (Add Members)

Patch Group (Remove Members)

Patch Group (rename Group)

Patch User (Add Email)

Patch User (Remove Email)

Patch User (update active field)

Patch User (update Display Name)

Patch User (update tracking field)

Ping

Schemas

Update Group

Update User

Users

<p class="slate-p " >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 " >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 " ></p><div class=card-group-box style="width:100%; min-width:540px;"><a href="https://developers.activtrak.com/activtrak/activtrak-public-apis/reports/reports-overview" target="_top" class="card-box-anchor without-icon"><div ><h3 class="slate-h3 " >Reports APIs</h3><p class="slate-p " >ActivTrak&apos;s Reports APIs (also known as Live Data API) are REST APIs that allow querying data from reports in ActivTrak. </p></div></a><a href="https://developers.activtrak.com/activtrak/activtrak-public-apis/administration/administration-overview" target="_top" class="card-box-anchor without-icon"><div ><h3 class="slate-h3 " >Administration</h3><p class="slate-p " >ActivTrak&apos;s Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.</p></div></a><a href="https://developers.activtrak.com/activtrak/activtrak-public-apis/bulk-import/bulk-import-overview" target="_top" class="card-box-anchor without-icon"><div ><h3 class="slate-h3 " >Bulk Import</h3><p class="slate-p " >ActivTrak&apos;s Bulk Import APIs (also known as the HR Data Connector) are REST APIs that facilitate the submission of data in a comma-separated value file format. </p></div></a></div><p class="slate-p " ></p><h3 class="slate-h3 " >API Keys</h3><p class="slate-p slate-indent-0" style="0px">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.</p><p class="slate-p slate-indent-0" style="0px">The features that you can access through your API keys are determined by your subscription plan as well as add-on. </p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:370px;"></div><div style="width:140px;">Reports</div><div style="width:86px;">Administration</div><div style="width:0px;">Bulk Import</div></div><colgroup ><col style="width:370px"><col style="width:140px"><col style="width:86px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Advanced/Essentials/Essentials Plus Plan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Advanced/Essentials Plan/Essentials Plus + ActivConnect Add-on</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Premium/ Professional Plan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Premium/Professional + ActivConnect Add-on</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Y</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Trial</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Free</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h3 class="slate-h3 " >Requirements</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">A current <a href="https://support.activtrak.com/hc/en-us/articles/360027324491-Subscription-Differences-Free-Advanced-Premium-" target="_blank">ActivTrak paid plan subscription</a></div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Requesting API Keys</h3><p class="slate-p slate-indent-0" style="0px">API keys may be created by your ActivTrak administrator from the ActivTrak app</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Within the navigation, select API &amp; Integrations &gt; API Keys</div></li><li class="slate-li " ><div style="position:relative">Click Create API Key</div></li><li class="slate-li " ><div style="position:relative">Follow the steps to request a new API key. After you submit the request, you will see the API key details.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Managing API Keys</h3><p class="slate-p slate-indent-0" style="0px">From the navigation, select API &amp; Integrations &gt; 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</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">View the name, requestor, creation date, and accessible APIs</div></li><li class="slate-li " ><div style="position:relative">Copy the API key</div></li><li class="slate-li " ><div style="position:relative">Delete the API key</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Authorizing Requests using API keys</h3><p class="slate-p slate-indent-0" style="0px">To authorize your API request using your API keys, set the header as indicated below, where “{apiKey}” is your API key.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">Authorization: Bearer {apiKey} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></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 slate-indent-0" style="0px">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.</p><p class="slate-p slate-indent-0" style="0px">Note: The Reports APIs currently support:</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 " >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 " >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 " >For assistance, please contact support@activtrak.com. </p><p class="slate-p " ></p><p class="slate-p " ></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.

Note: The Reports APIs currently support:

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

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 " >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 " ></p><p class="slate-p " ></p><p class="slate-p " ></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="0px">ActivTrak&apos;s Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note</strong>: The Administration APIs initially support:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">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 " >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 " >Please contact integrations-feedback@activtrak.com for questions and/or feedback.</p></div></div><p class="slate-p " ></p>

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

<p class="slate-p " >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 " >For more information about System for Cross-domain Identity Management (SCIM), see <a href="https://scim.cloud/" target="_self">https://scim.cloud/</a></p><p class="slate-p " ></p><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " >A special-use API key is required to use this API. Please reach out to <a href="mailto:integrations-feedback@activtrak.com" target="_self">integrations-feedback@activtrak.com</a> to obtain one.</p><p class="slate-p " ></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 " >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 " ></p><p class="slate-p " ></p><p class="slate-p " ></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 " ><span style="color:rgb(0, 0, 0)">ActivTrak&apos;s Consumers API enables multiple actions on consumers within an account. Consumers are users who have an account in the ActivTrak app. They can view the reports or administer the account. These are the same users shown under Settings&gt;Access&gt;App Access</span></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

ActivTrak's Consumers API enables multiple actions on consumers within an account. Consumers are users who have an account in the ActivTrak app. They can view the reports or administer the account. These are the same users shown under Settings>Access>App Access

<p class="slate-p slate-indent-0" style="0px">ActivTrak&apos;s Bulk Import APIs (also known as the HR Data Connector) are REST APIs that facilitate the submission of data in a comma-separated value file format. This API is currently in Beta.</p><p class="slate-p slate-indent-0" style="0px">This input informs ActivTrak to execute the following functions:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Automated user management</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Update user information</div></li><li class="slate-li " ><div style="position:relative">Create and update Groups</div></li><li class="slate-li " ><div style="position:relative">Add users to the Do Not Track list</div></li><li class="slate-li " ><div style="position:relative">Add and remove users from Groups</div></li><li class="slate-li " ><div style="position:relative">Delete users</div></li></ul></li></ul><p class="slate-p " >This API is used as part of ActivTrak&apos;s HR Data Connector (HRDC). </p><p class="slate-p slate-indent-0" style="0px">Please contact integrations-feedback@activtrak.com for the HRDC setup guide (plus sample CSV templates), any questions and/or feedback.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p " ></p>

ActivTrak's Bulk Import APIs (also known as the HR Data Connector) are REST APIs that facilitate the submission of data in a comma-separated value file format. This API is currently in Beta.

This input informs ActivTrak to execute the following functions:

This API is used as part of ActivTrak's HR Data Connector (HRDC). 

Please contact integrations-feedback@activtrak.com for the HRDC setup guide (plus sample CSV templates), any questions and/or feedback.

<p class="slate-p" placeholder="Type / for widgets">This API call will allow the import of user data for automating user management. This endpoint accepts files in CSV format.</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 will allow the import of user data for automating user management. This endpoint accepts files in CSV format.

Sections