ActivTrak Public APIs

## Sections
• [Introduction](https://developers.activtrak.com/activtrak-public-apis/introduction.md): 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. Reports Administration Bulk Import 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. Plain text Authorization: Bearer {apiKey} Authorization: Bearer {apiKey}
• [Overview](https://developers.activtrak.com/activtrak-public-apis/reports/reports-overview.md): 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: Working Hours Activity Log 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.
• [Working Hours](https://developers.activtrak.com/activtrak-public-apis/reports/working-hours.md): 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 article on Help Center
  • [Get working hours for users](https://developers.activtrak.com/activtrak-public-apis/reports/working-hours/get-working-hours-for-users.md): 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 computers](https://developers.activtrak.com/activtrak-public-apis/reports/working-hours/get-working-hours-for-computers.md): 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.
• [Activity Log](https://developers.activtrak.com/activtrak-public-apis/reports/activity-log.md): 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 article on Help Center
  • [Get activity log](https://developers.activtrak.com/activtrak-public-apis/reports/activity-log/get-activity-log.md): This API call returns a list of Activity Log objects
• [Overview](https://developers.activtrak.com/activtrak-public-apis/administration/administration-overview.md): 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: 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.
• [SCIM](https://developers.activtrak.com/activtrak-public-apis/administration/scim.md): This is the API for ActivTrak's next-gen user management based on SCIM. The endpoints are available in EARLY ACCESS. For more information about System for Cross-domain Identity Management (SCIM), see https://scim.cloud/ Authentication To obtain an API key, please visit the Integrations page and find the relevant SCIM integration.
  • [Ping](https://developers.activtrak.com/activtrak-public-apis/administration/scim/ping.md): Returns the API's uptime status.
  • [Schemas](https://developers.activtrak.com/activtrak-public-apis/administration/scim/schemas.md): ActivTrak's SCIM API supports the retrieval of supported SCIM schemas. The following schemas are supported: Core urn:ietf:params:scim:schemas:core:2.0:User urn:ietf:params:scim:schemas:core:2.0:Group Enterprise urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Custom urn:ietf:params:scim:schemas:extension:activtrak:2.0:User urn:ietf:params:scim:schemas:extension:activtrak:2.0:Group
    • [Get Schemas](https://developers.activtrak.com/activtrak-public-apis/administration/scim/schemas/get-schemas.md): Returns a list of supported SCIM schemas.
    • [Get Schema](https://developers.activtrak.com/activtrak-public-apis/administration/scim/schemas/get-schema.md): Returns a specified SCIM schema by URI.
  • [Users](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users.md): ActivTrak's SCIM API supports the retrieval, creation, update, and deletion of User entities. Supported Fields ActivTrak's SCIM API supports the following User fields:
    • [Get Users](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/get-users.md): Returns a list of ActivTrak Users.
    • [Get Users by Filter](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/get-users-by-filter.md): Returns a filtered list of ActivTrak Users. When filtering by userName, the filtered value will search across all existing UPN's and e-mails.
    • [Get User](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/get-user.md): Returns a single ActivTrak User by ID.
    • [Create User](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/create-user.md): Creates a new ActivTrak User. If the User already exists in ActivTrak, the new information associated with the User is updated.
    • [Update User](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/update-user.md): Updates an existing ActivTrak User by replacing it with the provided entity.
    • [Patch User (update Display Name)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-display-name.md): Updates an ActivTrak User's Display Name.
    • [Patch User (Add Email)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-add-email.md): Updates an ActivTrak User by adding an Email identifier.
    • [Patch User (Remove Email)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-remove-email.md): Updates an ActivTrak User by removing an Email identifier.
    • [Patch User (Add UPN)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-add-upn.md): Updates an ActivTrak User by adding a UPN identifier.
    • [Patch User (Remove UPN)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-remove-upn.md): Updates an ActivTrak User by removing a UPN identifier.
    • [Patch User (update Employee Number)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-employee-number.md): Updates an ActivTrak User's Employee Number (ID). Performing this operation will remove any existing Employee ID's for the User, while adding the new Employee ID value.
    • [Patch User (Add Employee Number)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-employee-number-copy-4.md): Adds an ActivTrak User's Employee Number (ID). Performing this operation will add the new Employee ID value, setting it as the primary Employee ID if there are multiple.
    • [Patch User (Remove Employee Number)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-employee-number-copy-5.md): Removes an ActivTrak User's Employee Number (ID).
    • [Patch User (update active field)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-active-field.md): Adds an ActivTrak User to the Do Not Track list and deletes their associated user agents. Updating this value to false adds the User to the Do Not Track list and deletes their associated user agents. Updating the value from false to true (re-provisioning) removes the User from the Do Not Track list, and attempts to restore any historical user agent data if it has not yet been deleted.
    • [Patch User (update tracking field)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/patch-user-update-tracking-field.md): Adds an ActivTrak User to the Do Not Track list. Updating this value to false adds the User to the Do Not Track list. Updating the value from false to true (re-provisioning) removes the User from the Do Not Track list.
    • [Delete User](https://developers.activtrak.com/activtrak-public-apis/administration/scim/users/delete-user.md): Adds an ActivTrak User to the Do Not Track list and deletes their associated user agents.
  • [Groups](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups.md): ActivTrak's SCIM API supports the retrieval, creation, update, and deletion of User Groups. Supported Fields ActivTrak's SCIM API supports the following Group fields: id displayName members value display $ref type meta resourceType created lastModified location version urn:ietf:params:scim:schemas:extension:activtrak:2.0:Group sourceType instanceId
    • [Get Groups](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/get-groups.md): Returns a list of ActivTrak Groups.
    • [Get Groups by Filter](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/get-groups-by-filter.md): Returns a filtered list of ActivTrak Groups.
    • [Get Group](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/get-group.md): Returns a single ActivTrak Group by ID.
    • [Create Group](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/create-group.md): Creates a new ActivTrak Group.
    • [Update Group](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/update-group.md): Updates an existing ActivTrak Group by replacing it with the provided entity.
    • [Patch Group (rename Group)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/patch-group-rename-group.md): Updates an ActivTrak Group by performing specified Patch operations.
    • [Patch Group (Add Members)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/patch-group-add-members.md): Updates an ActivTrak Group by performing specified Patch operations.
    • [Patch Group (Remove Members)](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/patch-group-remove-members.md): Updates an ActivTrak Group by performing specified Patch operations.
    • [Delete Group](https://developers.activtrak.com/activtrak-public-apis/administration/scim/groups/delete-group.md): Deletes an ActivTrak Group.
• [Clients](https://developers.activtrak.com/activtrak-public-apis/administration/clients.md): 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.
  • [Get all clients](https://developers.activtrak.com/activtrak-public-apis/administration/clients/get-all-clients.md): This API call returns a paged list of Clients . It returns the first page with up to 50 clients.
• [Consumers](https://developers.activtrak.com/activtrak-public-apis/administration/consumers.md): 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 Consumers API is currently in Early Access
  • [Get all consumers](https://developers.activtrak.com/activtrak-public-apis/administration/consumers/get-all-consumers.md): This returns a list of all Consumers . The optional paramater includeViewableGroups will return the list of Groups that the corresponding consumer has access to. If includeViewableGroups is not included in the URL query parameters, the default value will be false . When includeViewableGroups is set to true , consumers with the roles of PowerUser and Viewer will have all their groups listed in viewableGroups . Consumers with groupid -1 groupname All Users and Groups (current and future) indicates that they have access to all current and future Users and Groups. Lastly, consumers with the roles of Admin and Configurator will have groupid -1 groupname All Users and Groups (current and future)
  • [Get consumer](https://developers.activtrak.com/activtrak-public-apis/administration/consumers/get-consumer.md): Given an ID, this returns a Consumer . If the consumer is not found, a StatusResponse object is returned indicating the error. If the consumer has a role of PowerUser or Viewer , they will have all their groups listed in viewableGroups . If their groupid is -1 and groupname All Users and Groups (current and future) it indicates that they have access to all current and future Users and Groups. Lastly, if the consumer has a role of Admin and Configurator they will will have groupid -1 groupname All Users and Groups (current and future)
  • [Create consumers](https://developers.activtrak.com/activtrak-public-apis/administration/consumers/create-consumers.md): Create Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages. When specifying roles, only the following roles are allowed: Admin , Configurator , PowerUser , Viewer and only one role is allow in the roles array. Consumers with role Admin or Configurator will automatically have groupid with value -1 and groupname All Users and Groups (current and future) so they can view all current and future groups. Consumers with role PowerUser or Viewer may be given access to specific and existing groupid or groupname or to all current and future groups by providing -1 in the groupid .
  • [Patch consumers](https://developers.activtrak.com/activtrak-public-apis/administration/consumers/patch-consumers.md): Patch Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages. Either id or username may be used to identify a consumer to patch. Patching can be used for any combination of the following fields: viewableGroups , roles , ssoEnabled When specifying roles, only the following roles are allowed: Admin , Configurator , PowerUser , Viewer and only one role is allow in the roles array. Consumers with role Admin or Configurator will automatically have groupid with value -1 and groupname All Users and Groups (current and future) so they can view all current and future groups. Consumers with role PowerUser or Viewer may be given access to specific and existing groupid or groupname or to all current and future groups by providing -1 in the groupid . If the groupid has the value of -1 , the consumer's viewableGroups shall be All Users and Groups (current and future)
  • [Delete consumers](https://developers.activtrak.com/activtrak-public-apis/administration/consumers/delete-consumers.md): Delete Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages. The following list can have one or both, but must have one or the other: consumerIds , usernames
• [Overview](https://developers.activtrak.com/activtrak-public-apis/bulk-import/bulk-import-overview.md): 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: Automated user management Update user information Create and update Groups Add users to the Do Not Track list Add and remove users from Groups Delete users 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.