Introduction

This document outlines the procedure for creating ActivTrak API keys to access ActivTrak’s reporting endpoints, including working hours, activity logs, and user information.

ActivTrak uses API key authentication with x-api-key headers to secure API access.

What we need

[] API Token [] API SCIM Token

Security Warning

⚠️ The generated API key is sensitive and should be treated like a password. Never share it in insecure locations like public chat channels. Use a secure secret management system, such as a password manager or a dedicated secrets vault, to store and transmit the API key.

Step 1: Access ActivTrak API Settings

1. Log in to ActivTrak: Navigate to your ActivTrak app and sign in with administrator credentials
2. Navigate to API Settings: In the navigation menu, select API & Integrations > API Keys
3. Verify Permissions: Ensure you have administrator-level access to create API keys

Step 2: Create an API Key

1. Create New API Key: Click Create API Key
2. Configure API Key: Provide the following information:
   • Name: Assign a descriptive name (e.g., Parable Integration)
   • Purpose: Specify that this is for reporting/analytics integration
   • API Access: Ensure access to the Reports API is enabled
3. Submit Request: Complete the API key creation process

Step 3: Retrieve and Secure Your API Key

1. View API Key Details: After creation, you will see the API key details page
2. Copy API Key: Use the Copy button to copy the API key value
3. Store Securely: Save the API key in a secure location as it may not be viewable again
4. Note the Base URL: The ActivTrak API base URL is https://api.activtrak.com/

Step 4: Verify API Permissions

Confirm that your API key has access to:

• Reports API: Working hours, activity logs, and productivity reports
• User Information: Basic user data for reporting context
• Read-only access to reports and user data (no administrative permissions required)

Authentication Method

Include the API key in the x-api-key header of all API requests:

x-api-key: {apiKey}

Example API Request:

curl --location 'https://api.activtrak.com/reports/v2/workinghours/users?from=&to=' \
--header 'x-api-key: your_api_key_here' \
--header 'Content-Type: application/json'

Available API Endpoints

ActivTrak provides the following reporting endpoints:

• Working Hours: /api/v1/reports/working-hours/users and /api/v1/reports/working-hours/computers
• Activity Log: /api/v1/reports/activity-log
• User Information: Basic user data for associating with reports

Credentials to Share with Parable

Please provide the following to enable the ActivTrak integration:

• API Key: The API key you copied from ActivTrak

Note: Only share this API key through secure channels (encrypted email, password manager, or secure portal). Never share it in plain text or insecure communications.

Support Resources

• ActivTrak API Documentation: https://developers.activtrak.com/
• Support: Contact ActivTrak support for assistance if admin access is not available