> AquaLogic Analytics Query API Usage Guide > Tutorial: Using the Analytics Query API

AquaLogic Analytics Query API Usage Guide

     Previous Next  Open TOC in new window   View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Tutorial: Using the Analytics Query API

This chapter introduces you to the Analytics Query API through a series of example queries.

To use the SOAP messages in this tutorial, you must have the following software installed:
  • AquaLogic Analytics 2.5
  • AquaLogic Interaction 6.5
In addition, the (optional) Java example code requires one of the following environments:
  • Java SE 5 and Glassfish 9.0
  • Java EE 5

This tutorial describes how to query data using SOAP and the Analytics Query API. In addition to the SOAP messages, a Java example application is provided to send and receive SOAP messages. The Java example is not necessary to understand the tutorial. A developer who is proficient in working with SOAP on any development platform can easily adapt this tutorial for that development platform.

The following steps describe the tutorial at a high level:

  1. Create an application to send, receive, and process SOAP messages from the Query API service. For details, see Communicating With the Query API Service.
  2. Learn how to create SOAP queries to view which portlets are being used on your portal. For details, see Viewing Portlet Usage.
  3. Learn how to use filters to refine your queries. For details, see Filtering Portlet Usage by Community.
  4. Learn how to view events based on periods of time. For details, see Tracking Portlet Usage.
  • Communicating With the Query API ServiceThis topic leads you through the creation of a simple application that sends a SOAP message to the Query API Service and processes the response.
  • Viewing Portlet UsageThis topic describes how to use SOAP messages to report on portlet usage in the AquaLogic Interaction portal.
  • Filtering Portlet Usage by CommunityThis topic describes how to use the <filters> element to narrow queries of the Query API service to specific portal communities.
  • Tracking Portlet UsageThis topic describes how to use the <groups> element to track portlet usage based on periods of time.

  Back to Top      Previous Next