urlscan.io logo urlscan.io
SecurityTrails logo

knowledgecenter.zuora.com Open in urlscan Pro
2600:9000:2057:d400:1b:7e59:edc0:93a1  Public Scan

Back to summary
URL: https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/AA_AQuA_API_Introduction
Submission: On October 13 via api from GB — Scanned from GB

Form analysis 3 forms found in the DOM

https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/AA_AQuA_API_Introduction

<form id="searchForm" class="su__search-forms su__w-100 su__px-3 su__px-sm-1 su__m-0 ng-pristine ng-valid" ng-submit="clickSearch(true, true)"
  action="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/AA_AQuA_API_Introduction">
  <div class="su__d-flex su__form_height">
    <div class="su__search_form su__flex_box su__position-relative">
      <div class="su__w-100 su__bg-white-50 su__radius-2 su__position-relative su__autocomplete" ng-mouseleave="closeAutoComplete()">
        <input id="md-auto" class="su__form-control su__autocomplete-input su__md-autocomplete-rtl ng-pristine ng-untouched ng-valid ng-empty" type="text" placeholder="Search here" ng-model="searchString" ng-change="search(searchString)"
          ng-focus="search(searchString)" ng-keyup="($event.key == 'ArrowUp' || $event.key == 'ArrowDown' || $event.key == 'Enter') &amp;&amp; upOrDownKeyPress($event)" ng-model-options="{ debounce: 500 }" aria-invalid="false" style="">
        <!-- ngIf: searchString.length -->
        <!-- ngIf: showAutocompleteLoader -->
        <!-- ngIf: items.length !== 0 && showAutocomplete -->
      </div>
      <div class="input-group-button">
        <div class="advance-button-group" role="group">
          <button type="button" ng-click="clickSearch(true, true)" class="mt-inputredirect-button button button-success su__search-button">
          </button>
        </div>
      </div>
      <!-- </md-autocomplete> -->
      <!-- <div class="su__search_btn su__position-absolute su__zindex">
                        <div class="su__search-button su__btn su__bg-transparent" ng-click="clickSearch(false, true)">
                            <svg class="su__search-icons" version="1.1" id="Capa_1" x="0px" y="0px" viewBox="0 0 330 330" style="enable-background:new 0 0 330 330;" xml:space="preserve" xmlns="http://www.w3.org/2000/svg">
                                <path d="M325.606,304.394L223.328,202.117c16.707-21.256,26.683-48.041,26.683-77.111C250.011,56.077,193.934,0,125.005,0
                                C56.077,0,0,56.077,0,125.006C0,193.933,56.077,250.01,125.005,250.01c29.07,0,55.855-9.975,77.11-26.681l102.278,102.277
                                C307.322,328.536,311.161,330,315,330s7.678-1.464,10.606-4.394C331.465,319.749,331.465,310.251,325.606,304.394z M30,125.006
                                C30,72.619,72.619,30,125.005,30c52.387,0,95.006,42.619,95.006,95.005c0,52.386-42.619,95.004-95.006,95.004
                                C72.619,220.01,30,177.391,30,125.006z" ></path>
                                <g>
                                </g>
                            </svg>
                        </div>
                    </div> -->
    </div>
  </div>
</form>

/Special:Search

<form action="/Special:Search">
  <input name="qid" id="mt-qid-skin" type="hidden" value="">
  <input name="fpid" id="mt-search-filter-id" type="hidden" value="230">
  <input name="fpth" id="mt-search-filter-path" type="hidden">
  <input name="path" id="mt-search-path" type="hidden" value="">
  <label class="mt-label" for="mt-site-search-input"> Search </label>
  <input class="mt-text mt-search search-field" name="q" id="mt-site-search-input" placeholder="How can we help you?" type="search">
  <button class="mt-button ui-button-icon mt-icon-site-search-button search-button" type="submit"> Search </button>
</form>

POST https://knowledgecenter.zuora.com/Special:UserLogin?returntotitle=Zuora_Central_Platform%2FAPI%2FAB_Aggregate_Query_API%2FAA_AQuA_API_Introduction

<form action="https://knowledgecenter.zuora.com/Special:UserLogin?returntotitle=Zuora_Central_Platform%2FAPI%2FAB_Aggregate_Query_API%2FAA_AQuA_API_Introduction" class="mt-form" method="POST" id="quick-login">
  <div class="mt-field">
    <input autocomplete="off" class="reset mt-text" id="username" name="username" placeholder="Username" type="text">
    <label class="title login-form-label mt-label" for="username">Username</label>
  </div>
  <div class="mt-field">
    <input autocomplete="off" class="mt-text" id="password" name="password" placeholder="Password" type="password">
    <label class="title login-form-label mt-label" for="password">Password</label>
  </div>
  <div class="mt-field mt-submit">
    <button class="ui-button ui-button-primary" type="submit">Sign in</button>
  </div>
</form>

Text Content

Skip to main content
LOGIN
EMPLOYEE LOGINCUSTOMER LOGIN



AQUA API INTRODUCTION




 1. Search site
    Search Search
    Go back to previous article
 2. 1. Username
       Password
       Sign in
    2. Sign in
       * Sign in
       * Forgot password

Expand/collapse global hierarchy
 1. Home
 2. Zuora Central Platform
 3. API
 4. Aggregate Query API (AQuA)
 5. AQuA API Introduction

Expand/collapse global location


 * 日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。


AQUA API INTRODUCTION

 1. Last updated Oct 8, 2023
 2. Save as PDF
 3. 



Table of contents
 1. Why Use AQuA API?
 2. Authentication
 3. Steps overview
 4. Limits

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:

 * Stateless and Stateful Modes
 * AQuA Job Finder for monitoring purposes
 * Notification upon completion


AUTHENTICATION

Zuora recommends that you use OAuth v2.0 to authenticate to the REST API.
Authenticating via OAuth requires the following steps:

 1. Create an OAuth client in the Zuora UI

 2. Generate a bearer token

 3. Authenticate subsequent API requests by providing a valid bearer token in an
    HTTP header:
    
    Authorization: Bearer {token}

If you have Zuora Multi-entity enabled and your bearer token is valid for more
than one entity, use the Zuora-Entity-Ids header to specify which entity to
perform each API request in. If your bearer token is only valid for a single
entity, or you do not have Zuora Multi-entity enabled, you do not need to set
the Zuora-Entity-Ids header in your API calls.

See Authentication for more information about how to authenticate to the REST
API.


STEPS OVERVIEW

 1. Submit an aggregate query job

 2. Retrieve the job results 

 3. Retrieve the result file

 4. View AQuA requests and results in the AQuA Job Finder (optional)


LIMITS

AQuA enforces the following limits:

 * The maximum processing time per query is 3 hours. If a query in an AQuA job
   is executed for longer than 3 hours, this job will be killed automatically.
   See the best practices for bulk data extraction with AQuA.
 * AQuA enforces limits on both the stateful concurrent AQuA jobs and the
   stateless concurrent AQuA jobs per tenant:
   * The maximum number of stateful concurrent AQuA jobs per tenant is 50.
   * The maximum number of stateless concurrent AQuA jobs per tenant is 50.
   AQuA jobs in the following status are counted towards your concurrent
   AQuA job limits:
   * Submitted
   * Executing
   Zuora system will reject the subsequent stateful or stateless job requests
   once the corresponding concurrent job limit is reached.
 * The ChargeMetrics and ChargeMetricsDiscountAllocationDetail objects are not
   available through AQuA. You can access them through Data Query or Charge
   Metrics API.


 1. Back to top
 2. * Aggregate Query API (AQuA)
    * Post Query


RECOMMENDED ARTICLES

 1. Bulk data extraction from Zuora using AQuADescribes the best practices of
    using AQuA to replicate data to an external data warehouse
 2. AQuA API Error CodesProvides a list of AQuA API error codes and messages
 3. AQuA Job FinderDescribes the AQuA job finder, a UI for viewing all your AQuA
    requests and results
 4. Stateless and Stateful ModesDescribes AQuA API support for Stateless and
    Stateful modes and explains benefits of using each one
 5. Post QueryDescribes how to submit an aggregated list of ZOQL and Export ZOQL
    queries

 1. Article type Topic Stage Final
 2. Tags
     1. AQuA

 1. © Copyright 2023 Zuora
 2. Powered by CXone Expert ®


Feedback
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word word word word word word word word word
word word word word word word word word

mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1




FEEDBACK

What is your opinion?

Did you find what you are looking for?
Yes
No
Would you like to add a comment?
Add a screenshot of a specific area:
Click the camera icon to add a screenshot of a specific area

If you are open for us to contact you for further discussion, please leave your
email. (Optional)

Send


English
日本語

 * English
 * 日本語

English
Translated by AI