Introduction
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.
What made this section unhelpful for you?
API Access
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.
| Reports (endpoints for Live Data API) | ||
Advanced/Essentials/Essentials Plus Plan |
| Y | Y |
Advanced/Essentials Plan/Essentials Plus + ActivConnect Add-on | Y | Y | Y |
Premium/ Professional Plan |
| Y | Y |
Premium/Professional + ActivConnect Add-on | Y | Y | Y |
Trial |
|
|
|
Free |
|
|
|
Requirements
- A current ActivTrak paid plan subscription
- Deployed ActivTrak Agents that have started to collect activity data
Requesting API Keys
API keys may be created by your ActivTrak administrator from the ActivTrak app
- Within the navigation, select API & Integrations > API Keys
- Click Create API Key
- Follow the steps to request a new API key. After you submit the request, you will see the API key details.
Managing API Keys
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
- View the name, requestor, creation date, expiration date, and accessible APIs
- Copy the API key
- Delete the API key
Authorizing Requests using API keys
Select...
What made this section unhelpful for you?
Base URL
Production:
https://api.activtrak.com/
Production AU:
https://api-au.activtrak.com
Production CA:
https://api-ca.activtrak.com
Production EU:
https://api-eu.activtrak.com
Production UK:
https://api-uk.activtrak.com
Reports
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 API Access section.
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.
Administration
ActivTrak's Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.
Note: The Administration APIs initially support:
- NEW! API for ActivTrak's next generation user and group management
- Currently in testing and will be released soon in BETA!
- Legacy: Retrieval of user agent (ie client) information
For more information about getting access please see the API Access section.
Please contact integrations-feedback@activtrak.com for questions and/or feedback.
Bulk Import
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. These APIs are currently in Beta.
This input informs ActivTrak to execute the following functions:
- Automated user management (available now via /bulk)
- Create and update Groups
- Add users to the Do Not Track list
- Add and remove users from Groups
- Delete users
- Time-off identification (not yet available)
Please contact integrations-feedback@activtrak.com for questions and/or feedback.