DocumentationAPI ReferenceGet Started
Documentation

Overview

Suggest Edits

On this page:

AutoQL Set Up Overview

Get started with AutoQL by following the five steps outlined in this doc.

📘

Steps 1-3 are mandatory, steps 4 & 5 are conditional

  • Step 1: Access Your Service Account File
  • Step 2: Create JSON Web Tokens (JWT)
  • Step 3: Manage API Keys
  • Step 4: Manage Team
  • Step 5: Manage Projects

To complete these steps, you will need to access the Integrator Portal.

The AutoQL Integrator Portal (Portal) is a web app designed to help you implement and successfully manage your AutoQL deployment. It contains tools for developers, data for product managers, and serves as a helpful and easy-to-navigate graphical user interface (GUI) that enables you to facilitate many functionalities of the API.

If you require login information, please send us an email here. You can also learn more about the Integrator Portal here.

Step 1: Access Your Service Account File

To get set up with AutoQL, you will first require access to a Service Account File.

The Service Account File is an encrypted file containing the information you will need to create authentication (JWT) tokens and initialize your access to the AutoQL API.

Detailed instructions for accessing and decrypting your Service Account File can be found here.

Step 2: Create JSON Web Tokens (JWT)

Once you've accessed and decrypted your Service Account File, you will need to configure JSON Web Tokens (JWT) in order to access our REST API methods.

JWTs authenticate specific users of the API to allow user-level access and enable resource-specific permissions.

Detailed instructions for managing JWT Tokens can be found here.

Step 3: Manage API Keys

Next, you will need access to your API keys.

API keys are required to access our REST API methods either through code or through our front end Widgets. API keys give you access to your data, allow you to configure services, and permit access to our services.

Detailed information about API keys, including how to access, generate, and remove keys can be found here.

Step 4: Manage Team

Your team is comprised of the developers, data analysts, designers, marketers, and/or anyone else who is selected from within your company to monitor and administer AutoQL within your system.

Manage your team by assigning varying levels of access (or User Roles) to each individual who is involved with implementing and managing AutoQL at your organization.

Details pertaining to managing your team and User Roles can be found here.

Step 5: Manage Projects

A Project represents a source of data that can be queried with AutoQL. In order to query, you'll have to connect the Project to AutoQL so it knows where to send the query.

There are two types of Projects:

Production Projects

  • Production is the live environment where your users or projects will directly interact with your application.

Sandbox Projects

  • Sandbox is the testing environment where developers can trial queries before deploying to a live (Production) environment.

Details about how to set up and manage Projects can be found here.

Updated over 2 years ago