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.
Reports APIs
ActivTrak's Reports APIs (also known as Live Data API) are REST APIs that allow querying data from reports in ActivTrak.
Administration
ActivTrak's Administration APIs are REST APIs that support querying and administration of your ActivTrak account. These APIs are currently in Beta.
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.
API Keys
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.
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
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, and accessible APIs
- Copy the API key
- Delete the API key
Authorizing Requests using API keys
To authorize your API request using your API keys, set the header as indicated below, where “{apiKey}” is your API key.
What made this section unhelpful for you?
On this page
- Introduction