Engage 2013 - Flexible Data Access with APIs
0 likes670 views
The presentation provided an overview of Webtrends' APIs for flexible data access. The Webtrends DX API allows rapid integration with Excel and access to structured report data. The newer features allow sorting and filtering of API results. The Webtrends Generator provides a GUI to construct DX API requests. The Webtrends DC API was also discussed as a way to send mobile app data to Webtrends. The presentation concluded with the top five takeaways about using the DX and DC APIs.
![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](https://image.slidesharecdn.com/engage-2013flexible-data-access-with-apis-130205172904-phpapp02/85/Engage-2013-Flexible-Data-Access-with-APIs-13-320.jpg)
![Basic Query Parameters
• format={html|json|xml|xml2|csv}
• period_type={agg|indv|trend}
• totals={all|only|none}
*For use in Excel
• suppress_error_codes={true|false} suppress_error_codes
must be set to true!!!
• 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](https://image.slidesharecdn.com/engage-2013flexible-data-access-with-apis-130205172904-phpapp02/85/Engage-2013-Flexible-Data-Access-with-APIs-14-320.jpg)
Engage 2013 - Flexible Data Access with APIs
- 1. Flexible Data Access with APIs Brad Gross Program Manager, Webtrends
- 2. Agenda • Webtrends DX API • Generator (generator.webtrends.com) • Overview of the Webtrends DC API • Question / Answer
- 3. Flexible Data Access via the Webtrends DX API WEBTRENDS DX API
- 4. Why use the DX API?
- 5. Rapid Integration with Excel
- 6. Access to Structured Data
- 7. Easy to Transform Data T
- 8. The DX API is RESTful…
- 12. Need more help • https://ws.webtrends.com/v3/Reporting/help
- 13. 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
- 14. Basic Query Parameters • format={html|json|xml|xml2|csv} • period_type={agg|indv|trend} • totals={all|only|none} *For use in Excel • suppress_error_codes={true|false} suppress_error_codes must be set to true!!! • 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
- 15. A Simple Example
- 23. 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_da y-28&end_period=current_day&perio d_type=trend&format=html&suppress_e rror_codes=true
- 24. 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_da y-28&end_period=current_day&perio d_type=trend&format=html&suppress_e rror_codes=true https://ws.webtrends.com/v3/Reporting/ profiles/47839/Keymetrics/? totals=none&start_period=current_da y-56&end_period=current_day-29&pe riod_type=trend&format=html&suppress _error_codes=true
- 25. Excel: Rolling 28-Day Report
- 26. 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
- 27. 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
- 28. 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&me asures=5*6&suppress_error_codes=tru e
- 29. 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
- 30. 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
- 31. 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 }
- 32. 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_mon th&period_type=agg&format=html &suppress_error_codes=true
- 33. 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_mon th&period_type=agg&format=html &suppress_error_codes=true
- 34. Webtrends API Version Updates Will Force a Will Force a Will not Force a Major Version Point Version Version Update Update Update A change that A change that A change to has the potential will not impact address specific to break an current needs to meet application using applications internal this version requirements
- 36. Open Data Exploration using Generator WEBTRENDS GENERATOR
- 39. Flexible Data Exchange via the DC API WEBTRENDS DC API
- 40. The Webtrends Developer Network • In order to download the DC API you must have a Webtrends Developer Network account https://developer.webtrends.com/
- 41. Downloading the DC API • Once registered you will have access to enter the Data IN section of the Developer Network https://developer.webtrends.com/
- 42. 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/
- 43. Downloading the DC API • Download the Sample.zip file https://developer.webtrends.com/docs/DOC-1151
- 44. The DC API In Action!!!
- 45. The DC API In Action!!!
- 46. 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!!!
- 47. Thank You Brad Gross, Program Manager Paul Lawbaugh, Senior Program Manager Webtrends brad.gross@webtrends.com
- 48. Rate Session & Speakers/ Panelists