engage 2013 - flexible data access with apis
DESCRIPTION
TRANSCRIPT
![Page 1: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/1.jpg)
Flexible Data Access with APIs Brad Gross
Program Manager, Webtrends
![Page 2: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/2.jpg)
Agenda
• Webtrends DX API
• Generator (generator.webtrends.com) • Overview of the Webtrends DC API
• Question / Answer
![Page 3: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/3.jpg)
WEBTRENDS DX API Flexible Data Access via the Webtrends DX API
![Page 4: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/4.jpg)
Why use the DX API?
![Page 5: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/5.jpg)
Rapid Integration with Excel
![Page 6: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/6.jpg)
Access to Structured Data
![Page 7: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/7.jpg)
Easy to Transform Data
T
![Page 8: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/8.jpg)
The DX API is RESTful…
![Page 9: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/9.jpg)
https://ws.webtrends.com/v3/Reporting/profiles/
![Page 10: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/10.jpg)
https://ws.webtrends.com/v3/Reporting/profiles/47839/reports/
https://ws.webtrends.com/v3/Reporting/profiles/
![Page 11: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/11.jpg)
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/
![Page 12: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/12.jpg)
Need more help • https://ws.webtrends.com/v3/Reporting/help
![Page 13: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/13.jpg)
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
![Page 14: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/14.jpg)
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!!!
![Page 15: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/15.jpg)
A Simple Example
![Page 16: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/16.jpg)
Excel Integration 101
![Page 17: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/17.jpg)
Excel Integration 101
![Page 18: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/18.jpg)
Excel Integration 101
![Page 19: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/19.jpg)
Excel Integration 101
![Page 20: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/20.jpg)
Excel Integration 101
![Page 21: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/21.jpg)
Excel Integration 101
![Page 22: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/22.jpg)
Excel Integration 101
![Page 23: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/23.jpg)
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
![Page 24: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/24.jpg)
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
![Page 25: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/25.jpg)
Excel: Rolling 28-Day Report
![Page 26: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/26.jpg)
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
![Page 27: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/27.jpg)
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
![Page 28: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/28.jpg)
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
![Page 29: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/29.jpg)
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
![Page 30: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/30.jpg)
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
![Page 31: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/31.jpg)
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 }
![Page 32: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/32.jpg)
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
![Page 33: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/33.jpg)
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
![Page 34: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/34.jpg)
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
![Page 35: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/35.jpg)
Some Example Dashboards
![Page 36: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/36.jpg)
WEBTRENDS GENERATOR Open Data Exploration using Generator
![Page 37: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/37.jpg)
http://generator.webtrends.com
![Page 38: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/38.jpg)
![Page 39: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/39.jpg)
WEBTRENDS DC API Flexible Data Exchange via the DC API
![Page 40: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/40.jpg)
The Webtrends Developer Network
• In order to download the DC API you must have a Webtrends Developer Network account
https://developer.webtrends.com/
![Page 41: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/41.jpg)
Downloading the DC API • Once registered you will have access to enter the Data
IN section of the Developer Network
https://developer.webtrends.com/
![Page 42: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/42.jpg)
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/
![Page 43: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/43.jpg)
Downloading the DC API
• Download the Sample.zip file https://developer.webtrends.com/docs/DOC-1151
![Page 44: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/44.jpg)
The DC API In Action!!!
![Page 45: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/45.jpg)
The DC API In Action!!!
![Page 46: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/46.jpg)
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!!!
![Page 47: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/47.jpg)
Thank You
Brad Gross, Program Manager Paul Lawbaugh, Senior Program Manager
Webtrends
![Page 48: Engage 2013 - Flexible Data Access with APIs](https://reader033.vdocument.in/reader033/viewer/2022061218/54b6a3a94a7959b5588b471a/html5/thumbnails/48.jpg)
Rate Session
& Speakers/ Panelists