Engage 2013 - Flexible Data Access with APIs

Flexible Data Access with APIs Brad Gross

Program Manager, Webtrends

Agenda

•  Webtrends DX API

•  Generator (generator.webtrends.com) •  Overview of the Webtrends DC API

•  Question / Answer

WEBTRENDS DX API Flexible Data Access via the Webtrends DX API

Why use the DX API?

Rapid Integration with Excel

Access to Structured Data

Easy to Transform Data

T

The DX API is RESTful…

https://ws.webtrends.com/v3/Reporting/profiles/

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/

https://ws.webtrends.com/v3/Reporting/profiles/

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/

https://ws.webtrends.com/v3/Reporting/profiles/

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/oOEWQj3sUo6/

Need more help •  https://ws.webtrends.com/v3/Reporting/help

Basic Query Parameters •  format={html|json|xml|xml2|csv} •  period_type={agg|indv|trend} •  totals={all|only|none} •  suppress_error_codes={true|false} •  start_period and end_period

– Can be explicitly defined •  <yyyy>[m<MM>d<dd>h<HH>] (e.g. 2012m03d12)

– Can use date macros •  current_year, current_month, current_day,

current_hour, current_day_midnight

Basic Query Parameters •  format={html|json|xml|xml2|csv} •  period_type={agg|indv|trend} •  totals={all|only|none} •  suppress_error_codes={true|false} •  start_period and end_period

– Can be explicitly defined •  <yyyy>[m<MM>d<dd>h<HH>] (e.g. 2012m03d12)

– Can use date macros •  current_year, current_month, current_day,

current_hour, current_day_midnight

*For use in Excel suppress_error_codes must be set to true!!!

A Simple Example

Excel Integration 101

Excel Integration 101

Excel Integration 101

Excel Integration 101

Excel Integration 101

Excel Integration 101

Excel Integration 101

Excel: Rolling 28-Day Report

•  Building on the concepts in the prior example

https://ws.webtrends.com/v3/Reporting/profiles/47839/Keymetrics/?totals=none&start_period=current_day-28&end_period=current_day&period_type=trend&format=html&suppress_error_codes=true

Excel: Rolling 28-Day Report

•  Building on the concepts in the prior example

https://ws.webtrends.com/v3/Reporting/profiles/47839/Keymetrics/?totals=none&start_period=current_day-28&end_period=current_day&period_type=trend&format=html&suppress_error_codes=true

https://ws.webtrends.com/v3/Reporting/profiles/47839/Keymetrics/?totals=none&start_period=current_day-56&end_period=current_day-29&period_type=trend&format=html&suppress_error_codes=true

Excel: Rolling 28-Day Report

New API Features

Exciting new API features allow users to sort and apply complex filtering logic to their results •  Two new query parameters

– sortby – query

Get Sorted!!! •  As an example, let’s say you’re interested in the top performing ad

campaigns over the course of the prior month.

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/2Ht766mdyx6/?totals=all&start_period=current_month-1&end_period=current_month-1&period_type=agg&format=html&measures=5*6&suppress_error_codes=true

Get Sorted!!! •  As an example, let’s say you’re interested in the top performing ad

campaigns over the course of the prior month.

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/2Ht766mdyx6/?totals=all&start_period=current_month-1&end_period=current_month-1&period_type=agg&format=html&measures=5*6&suppress_error_codes=true

https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/2Ht766mdyx6/?totals=all&start_period=current_month-1&end_period=current_month-1&period_type=agg&sortby=1&format=html&measures=5*6&suppress_error_codes=true

For Those With a Keen https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/2Ht766mdyx6/?totals=all&start_period=current_month-1&end_period=current_month-1&period_type=agg&format=html&measures=5*6&suppress_error_codes=true

For Those With a Keen https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/2Ht766mdyx6/?totals=all&start_period=current_month-1&end_period=current_month-1&period_type=agg&format=html&measures=5*6&suppress_error_codes=true

Query On! •  Users can apply complex filtering logic

to their results by constructing a query •  A query is comprised of conditional

statements linked together by standard boolean operators { AND | OR }

A Simple Example

•  For example: – Let’s say you need to assemble a

report for international site pages https://ws.webtrends.com/v3/

Reporting/profiles/28197/reports/oOEWQj3sUo6/?query=Page NOTLIKE *com/*&totals=all&start_period=current_month-1&end_period=current_month&period_type=agg&format=html&suppress_error_codes=true

A Simple Example

•  For example: – Let’s say you need to assemble a

report for international site pages https://ws.webtrends.com/v3/

Reporting/profiles/28197/reports/oOEWQj3sUo6/?query=Page NOTLIKE *com/* AND Page NOTLIKE *test/*&totals=all&start_period=current_month-1&end_period=current_month&period_type=agg&format=html&suppress_error_codes=true

Webtrends API Version Updates

Will Force a Major Version Update

Will Force a Point Version Update

Will not Force a Version Update

A change that has the potential to break an application using this version

A change that will not impact current applications

A change to address specific needs to meet internal requirements

Some Example Dashboards

WEBTRENDS GENERATOR Open Data Exploration using Generator

http://generator.webtrends.com

WEBTRENDS DC API Flexible Data Exchange via the DC API

The Webtrends Developer Network

•  In order to download the DC API you must have a Webtrends Developer Network account

https://developer.webtrends.com/

Downloading the DC API •  Once registered you will have access to enter the Data

IN section of the Developer Network

https://developer.webtrends.com/

Downloading the DC API •  On the right side of the page there will be a link to

‘Sample Client Code’

https://developer.webtrends.com/community/dc/

Downloading the DC API

•  Download the Sample.zip file https://developer.webtrends.com/docs/DOC-1151

The DC API In Action!!!

The DC API In Action!!!

Top 5 Take-Aways

•  The DX API allows you to rapidly present report data in Excel

•  The New DX API features allow you to quickly sort and filter your data

•  The DX API versioning allows you to gracefully navigate the API landscape

•  Webtrends Generator provides an easy to use GUI that allows you to quickly construct REST requests

•  Send data from your mobile apps using the DC API!!!

Thank You

Brad Gross, Program Manager Paul Lawbaugh, Senior Program Manager

Webtrends

[email protected]

Rate Session

& Speakers/ Panelists