ActivConnect API Documentation & Setup Guide

ActivTrak will set up your instance of ActivConnect in a hosted Google Cloud Account, usually within 24 hours. You will then be provided with credentials to access your account. 

Note: You can query up to 1TB of data per month (the equivalent of 3.2GB records) which is more than enough for most customers. 

ActivConnect API Documentation

To access API documentation, click here.

Accessing ActivConnect

After receiving your credentials, there are several ways you can access ActivConnect:

 

Method 1: Use Google BigQuery API

 

The ActivConnect API includes access to your complete historical ActivTrak dataset via Google BigQuery. The following API documentation contains the most common operations you may need to perform via the Google BigQuery API. 

Common Use Cases

Some common scenarios in which you might use the ActivConnect API include:

  • Query the predefined views available with your account’s subscription plan. The predefined views are described in the ActivConnect Data Glossary.
  • Create custom queries within the access bounds of your subscription plan.

Access ActivConnect Data

Retrieving the data from a data set can be accomplished in different ways:

Command-line interface

1. Authenticate with Google:

 

gcloud auth login

 

2. Use the execute with the following command that includes your query where:

  • project = us-activtrak-ac-prod
  • datasetId = your six-digit ActivTrak account ID
  • tableId = string name of a predefined view within your data set

 

bq query --use_legacy_sql=false 'SELECT * FROM 
`us-activtrak-ac-prod.123456.events` LIMIT 100'

Language Libraries

 

Method 2: Use ActivTrak's Live Data API

 

ActivTrak's Live Data API is a REST API that allows querying data from the Reporting Service. This up-to-the-minute 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.

Access the Live Data API documentation here.

 

Method 3: Use Pre-built Templates in ActivConnect

 

Jumpstart your analysis with our pre-built templates containing a robust set of reports in the areas of Activity & Application Usage, Productivity, Collaboration & Knowledge Management and Compliance & Risk Management. Review the setup guides below:

  1. Microsoft Power BI Setup Guide
  2. Tableau Setup Guide
  3. Google Data Studio Setup Guide

 

Method 4: Use Google BigQuery Console

 

Follow the instructions below to access ActivConnect via Google BigQuery Console to access your data via SQL queries:

  1. Using your credentials, you can verify access to your data in ActivConnect in BigQuery by clicking on the URL below:
    https://console.cloud.google.com/
  2. This will prompt you to log in using your Google Account credentials that end with "activtrak.us". 
  3. Once you are logged in, you will see your data instance on the left-hand side of the Google BigQuery Console (called ‘activtrak-us): 

Data_Connect_-_Quick_start_guide.png

4.  Query your activity data within the BigQuery console using SQL statements that access your account’s logs table within the activtrak-us. The prototypical SQL query statement should look like the select statement below.

Note: youraccountnumber should be replaced with your six-digit ActivTrak account number. 

Use this sample query limited to 100 rows to test if you can access your data.

Select * from `activtrak-us.youraccountnumber.logs`

limit 100;

Data_Connect_-_quick_start_guide_2.png

For reference, as you start exploring your activity data, you can access the ActivConnect Data Glossary describing the available fields and a Sample Data Output.

 

Method 5: Use a BI/Data Visualization Tool to Create Reports from Scratch

 

Click on the name of each tool below to access instructions for accessing ActivConnect using a BigQuery connection:

Next, follow the below steps:

  1. Select the ‘activtrak-com’ project.
  2. Select the dataset with your six-digit account number. 
  3. Select the ‘logs’ table within your dataset.
  4. Query your activity data and start creating reports.
  5. For reference as you start exploring your activity data, you can access a Data Dictionary describing the available fields in the Appendix of this document

For additional assistance, please contact Support.

 

Was this article helpful?

4 out of 7 found this helpful

Comments

No comments