ActivTrak will set up your ActivConnect instance in a hosted Google Cloud Account, usually within 24 hours. You will then be provided with credentials to access your account. To access ActivConnect API documentation, click here.
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.
Contents
- Use Google BigQuery API
- Use ActivTrak's Live Data API
- Use pre-built templates for Microsoft Power BI, Tableau or Google Data Studio
- Use Google BigQuery Console to access your data via SQL queries
- Use a BI/data tool of your choice to access ActivConnect and create custom reports
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 dataset can be accomplished in different ways:
Command-line interface
- Authenticate with Google:
gcloud auth login
- Use the execute with the following command that includes your query, where:
project = us-activtrak-ac-prod
datasetId = your six-digit ActivTrak account number
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
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. Depending on when we receive data from installed Agents, data should appear near real-time.
Access the Live Data API documentation here.
Use pre-built templates in ActivConnect
Jumpstart your analysis with our pre-built templates, which include a robust set of reports across Activity & Application Usage, Productivity, Collaboration & Knowledge Management, and Compliance & Risk Management. Review the setup guides below:
- Setup Guide: ActivTrak for Power BI
- Setup Guide: ActivTrak for Tableau
- Setup Guide: ActivTrak for Google Data Studio
Use Google BigQuery Console
Follow the instructions below to access ActivConnect via Google BigQuery Console to access your data via SQL queries:
- Using your credentials, you can verify access to your data in ActivConnect in BigQuery by navigating to https://console.cloud.google.com/
- This will prompt you to log in using your Google Account credentials that end with "activtrak.us".
- Once you are logged in, you will see your data instance on the left-hand side of the Google BigQuery Console (called ‘activtrak-us):
Query your activity data in the BigQuery console using SQL statements that access your account’s logs table in 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;
As you start exploring your activity data, you can access the ActivConnect Data Glossary, which describes the available fields and includes a Sample Data Output.
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:
- Select the ‘activtrak-com’ project.
- Select the dataset with your six-digit account number.
- Select the ‘logs’ table within your dataset.
- Query your activity data and start creating reports.
- 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.