Introduction

This documentation is about an Early Adopter feature and the instructions detailled here are subject to changes. Please contact your usual AB Tasty contact if some instructions are unclear or if something is missing.

Data Explorer is an API you can use to get data from your dataset where we store everything we have collected about your visitors. You can either use it has a direct query when looking for something specific or automate it using a script on your end.

Access

For AB Tasty client-side

In order to execute a query towards the API, you will have to authentify first using a valid Public API token. Your clientId and secretId will be shared when creating an API user in the interface (for AB Tasty).

We do not store your personal clientId and secretId and we won't display it again, so make sure to write it down somewhere safe.

For AB Tasty server-side

Getting data from a server-side database using Data Explorer requires to use your session token (found in the session or in the UI Integration > Token) instead of a Remote Control API token.

Usage

Besides a valid token, the API expect a valid payload containing all your parameters. A valid payload will launch the gathering of your requested data. Keep in mind that depending on the volume and the complexity of your query, it might takes several seconds to execute. Once the query has succesffully gathered all the data, it will be return to you as a JSON file.

More on that here.

Dimensions and metrics list

The data can be retrieved through dimensions and metrics. Dimensions are the raw collected data corresponding most of the time to parameters that were send in the collect pipeline and metrics are numbers that are computed on-the-go depending on your request.

You can find both lists here.

Payload generator

To help you in the usage of the API, we have published a very basic (but efficient!) payload generator. Using a UI, you will be able to generate a payload that can be then used on your side. Keep in mind that this payload generator doesn't cover all the features of Data Explorer.

The payload generator can be found here.

Quota management

To frame the usage of the API and limit the volume of data being extracted, each account has a monthly quota. Each request will consume this quota and you won't be able to do request anymore once you've reach the limit of your quota until the next month.

To help you in the management of your quota, the API provides tools to simulate a request or return your current quota status.

More on that here.

Global limits

In addition of the quota, we have added fixed limits to avoid abnormal requests. These limits are set on the maximum time window and query size.

Walkthrough

To help you learn how to use the API, you can follow the walkthrough in which you will see several requests gradually more complex.

You can find this walkthrough here