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
- Integrates with Excel without coding, client software, or installed driver--you
need only your Webtrends credentials to get data
- Returns the entire data set for a trend in response to a single URI (for example, trending a month
- Is profile and account independent, so you can list multiple profiles by
changing the profile name in the URI
- Provides macros that enable you to request data for “yesterday” or “this
Notation), XML, HTML and CSV output of any object for use in Web 2.0 mashups, widgets and
- Enables creation of AJAX applications (or any other web interface for Webtrends
- Caches data for better performance
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,
- Averages and percentages for measures in drill-down reports -- these are
shown in the user interface so measures are not blank when the drill-down is
collapsed. These are excluded from Data Extraction API responses.
- Sortable "Measures" column -- this contains a calculation designated as
an average that is not valid for comparison. This measure average is not
equivalent to the actual measure (which may itself be designated as an average,
for example, "Average Visits").
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
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
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