Workflow for Analytical Reporting API
Asynchronous Usage
-
Optional. If desired, a custom reporting view template is created or modified using web service calls.
-
The client application posts a job to the job queue, specifying a view template.
-
The client application polls the job status until the job is complete.
-
When the job is complete, output is batched into ZIP files containing up to the maximum records permitted by the system limit. If the number of records should exceed the system limit records are broken into pages containing up to the system maximum records. In this case, the response includes a page token that can be passed in the next query to retrieve the next page of records, and fields to help navigate and enumerate the results set.
-
The client application requests one file at a time.
-
Downloaded ZIP files are extracted and report data is processed as desired.
Synchronous Usage
-
Optional. If desired, a custom view template is created or modified using web service calls.
-
The client application requests the first batch of report data, specifying a view template. The response includes up to 5,000 records.
-
The client application requests subsequent batches of report data, each containing up to 5,000 records, as needed.
-
Report data is processed as desired.