Blog

How to Use Splunk Web Optimization’s Real Browser Check API Data Pull Tool

There’s the old adage that knowledge is power. We like to think that the same is true of data because it provides insight and can be used as a jumping off point to make informed decisions. Our Optimization product, for instance, is predicated on helping our customers take informed, strategic actions based on the performance data Splunk Web Optimization provides.

Within Splunk Web Optimization, users can read data in graphs or dashboards or pull data point-by-point. But what if someone wanted to pull their raw load data out of Splunk Web Optimization? This was the challenge that a customer faced, as they wanted to export raw load time data into their own spreadsheet in order to track page-load performance over time.

To help address this roadblock, we created the RBC API Data Pull Tool, the purpose of which is to allow customers to directly and easily access their raw load time data, allowing them to completely customize their reporting processes.

This GUI leverages user-friendly inputs (such as checkboxes and textboxes) to allow users to input API Key, identify Check ID, and select parameters, such as load time type and time frame, and generate an API call. The tool then uses the Splunk Web Optimization API to pull all RBCs in the account. Multiple load time types can be selected, with each type pulling data into a new sheet.

Use Cases

There are a few use cases for this tool. For instance, with it you can:

  • Review the number of Real Browser Checks in an account as well as the status and frequency of each check
  • Quickly export raw load time data for custom manipulation and reporting
  • Compare the server time, speed index, on load time, etc. for a single page across multiple weeks
  • Determine if the difference between server time and fully loaded time is trending upwards or downwards over time
  • Check that each run of a Real Browser Check is operating as expected

 

Using the Tool

1. Make a copy of the spreadsheet

The spreadsheet is shared read-only, so you’ll first need to make a copy. This tool has not yet been verified by Google, so you will have to provide authorization for the tool (follow the instructions on the spreadsheet).

2. Enter your API Key

When the sidebar loads and after the script has been enabled, enter your API Key into the sidebar. You can find your API Key here.

Once you have entered your API Key, click RUN to populate the spreadsheet with data for all RBCs in your account
NOTE: The tool hits the API endpoint. The parameters can be edited in the script to customize the tool. More information on the Splunk Web Optimization API and available parameters is available here

3. Grab the Check ID and run the tool

Select the Check ID for the check you want to pull data for (Column A) and copy it into the sidebar where prompted. Then, select the appropriate metrics you want to pull data for. Finally, choose a timeframe for the data. Note: if you select Custom, you will be asked to select a From Date and a To Date.

NOTE: Timing data is rolled-up based on timeframe:

0-24 hours: every run is returned;
24 hours – 3 days: hourly rollups;
Over 3 days: daily rollups

Additional information, is available in the Splunk Web Optimization Knowledge Base.

4. Delete Sheets

Every time the tool is run, one new sheet will be added for each timing checked. Quickly delete all report sheets by clicking the “Delete Reports” button at the bottom of the sidebar.

NOTE: Do NOT delete the sheet titled “CHECKS_LIST”.

 

 

Learn more about Digital Experience Monitoring