https://github.com/trulia/webpagetest-charts-api

An api of endpoints to build charts from WebPagetest results
https://github.com/trulia/webpagetest-charts-api

Last synced: about 2 months ago
JSON representation

An api of endpoints to build charts from WebPagetest results

• Host: GitHub
• URL: https://github.com/trulia/webpagetest-charts-api
• Owner: trulia
• License: mit
• Created: 2015-03-24T21:30:58.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T20:59:52.000Z (6 months ago)
• Last Synced: 2024-07-21T03:36:16.478Z (2 months ago)
• Language: JavaScript
• Size: 69.3 KB
• Stars: 67
• Watchers: 15
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# WebPagetest Charts API

[WebPagetest](http://www.webpagetest.org/) Rules. There are tools that are easier to use, but nothing that lets you

really see deeply into the browser side of things. But there's no easy way to compare results over time.

So this is a small express application that runs tests, stores them, and offers endpoints to access the

data. It assumes that you'll want to look at a variety of charts for your data, so the

following datapoints are available:

- SpeedIndex: Google's special score.  It's an excellent

summtion of how Google will see your site, and a great

numerical indicator for how fast your site feels to

visitors. Read the  [SpeedIndex docs](https://sites.google.com/a/webpagetest.org/docs/using-webpagetest/metrics/speed-index)  for more info

- loadTime: How long (ms) to load the critical page content

- fullyLoaded: How long (ms) to fully load all the page content

- ~~requests: how many requests are made when loading the page~~ (needs update for new API response)

- TTFB: time to the first byte recieved, rumored to be the most important for SEO

- visualComplete: Time (ms) until the page is done changing visually

- Lighthouse Suite: [Lighthouse](https://developers.google.com/web/tools/lighthouse/) tracks a lot of metrics, the ones WepageTest expsoses are:

  - Performance

  - Performance.speed-index-metric

  - Performance.first-meaningful-paint

  - Performance.estimated-input-latency

  - Performance.first-interactive

  - Performance.consistently-interactive

  - BestPractices

  - Accessibility

  - SEO

  - ProgressiveWebApp

It also keeps links to

the full WebPagetest results for deeper introspection. You can build a UI on

this API. A working example is https://github.com/trulia/webpagetest-charts-ui. Visit that repo to see screenshots of what it can display.

And none of this would have happened without [marcelduran](https://github.com/marcelduran) and his

[webpagetest-api](https://github.com/marcelduran/webpagetest-api)

module which made the data side of this very easy to prototype quickly.

## How It Works

In this repo, there's no database: just the file system. (The data storage logic is its own

module, so it could be replaced with something else, mongo, etc. PRs welcome!) The app saves results into

`public/results///