Knowledge Center

Knowledge Center > API > Aggregate Query API (AQuA) > AQuA API Introduction

AQuA API Introduction

The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database transaction.

Why Use AQuA API?

Using the AQuA API, you can do the following:

  • Continuously query data

You can export data incrementally, instead of exporting all of the data, all the time.

  • Export deleted data
  • Export files in segments

When you have large amounts of data, you can export your data in segments, instead of using bulky exports which can timeout.

In addition, AQuA API supports the following:

Authentication

Use one of the following methods to authenticate:

  • Use Basic Authentication and pass your Zuora username and password.

  • Use a valid Zuora Session ID, which you can get by using login() call. The request header must contain the following information:

    Authorization: ZSession <id>

    Where id is the Zuora login session ID. For example:

    Authorization: ZSession QWxhZGRpbjpvcGVuIHNlc2FtA

Authentication for Multi-entity

If you use Zuora Multi-entity, use one of the following methods to authenticate:

  • Use Basic Authentication and pass your Zuora username and password. Optionally, you can also specify the entityId or entityName parameter in the authentication.

    The entityId parameter specifies the Id of the entity that you want to access. The entityName parameter specifies the name of the entity that you want to access. Note that you must have permission to access the entity. You can get the entity Id and entity name through the REST GET Entities call.

    You can specify either the entityId or entityName parameter in the authentication to access and view an entity.

    To export data from an entity, if you specify the entity Id or entity name in the request header of the POST query request, you must specify the same entity Id or entity name in the following Get Job Results, Get Results Files, and any other calls too. Otherwise, you cannot get the results for this entity.

    • If both entityId and entityName are specified in the authentication, an error occurs. 

    • If neither entityId nor entityName is specified in the authentication, you will log in to the entity in which your user account was created. 

    See API User Authentication for more information.

  • Use a valid Zuora Session ID, which you can get by using login() call. The request header must contain the following information:

    Authorization: ZSession <id>

    Where id is the Zuora login session ID. For example:

    Authorization: ZSession QWxhZGRpbjpvcGVuIHNlc2FtA

    You will make a call to the entity in which your user account was created. You cannot access other entities using this authentication method.

Last modified
11:05, 26 Oct 2016

Tags

This page has no custom tags.

Classifications

(not set)