About the Data Extraction API

The Data Extraction API enables you to retrieve Webtrends Analytics on demand report data, and monitor key metrics for profiles. The Data Extraction API conforms to the REST (Representational State Transfer) API architecture.

Benefits for Analytics

Data Extraction API vs. Analytics User Interface

The Data Extraction API exchanges and transfers stored data only, so the report data from it will not always match the data seen at the Analytics user interface, because some reports in Webtrends Analytics 9 may contain numbers resulting from rounding, limiting decimals, or averaging subtotals. Data Extraction API report data does not include averages (unless they are a measure of actual analyzed data--see note below), subtotals or other values sometimes shown in the Analytics user interface, specifically:

Note: An example of an average that is actual analyzed data returned by the Data Extraction API is a customer-created measure called “Average RSS Feed Subscriptions”. It is based on a parameter, and stored in the report table, as opposed to derived at display time.

How does it work?

You compose a URI to describe the data you want:

The REST API call is a URI with protocol, server, version, profile ID, and other required and optional parameters.
Note: The alphanumeric GUIDs are still valid.

The request is processed, data is extracted, an an extract file is created for retrieval from the SFTP site (or to stream to the client using another web services method).

Note: A request is a set of criteria for extracting data. In Data Scheduler, you create a request by clicking New on the Upcoming Requests dialog in the Data Scheduler user interface, and completing the fields in the resulting dialog. An extract is the resulting file (as seen in the Available Files dialog). A request can generate many extracts.