Badge request: Webpagetest
- Dominant language
- JavaScript
- Stars
- 27.2k
- Forks
- 5.6k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 46
Description
:clipboard: **Description**
- Which service is this badge for e.g: Webpagetest
https://www.webpagetest.org/
- What sort of information should this badge show?
This is a speed webpage test, so the info could any of the info you get from the test.
Lets start with the simplest one: Load Time
Webpagetest | 4.34s
And maybe we could get some colours depending of the number: but that is an extra.
We could also get:
- First Byte
- the Speed Index: https://sites.google.com/a/webpagetest.org/docs/using-webpagetest/metrics/speed-index
- Number of requests
- Size of the page... etc.
:link: **Data**
Where can we get the data from?
- Is there a public API?
Yes.
- Does the API requires an API key?
Yes. You can get one here:
https://www.webpagetest.org/getkey.php
- Link to the API documentation.
https://sites.google.com/a/webpagetest.org/docs/advanced-features/webpagetest-restful-apis
This post is also really useful:
https://css-tricks.com/use-webpagetest-api/
The idea is to be able to show quickly the performance of the website. Really important these days.
Thanks
Contributor guide
Research direction
Start with the WebPageTest REST API documentation and the linked CSS-Tricks article to understand authentication and how to retrieve load time data. Done means adding a WebPageTest badge that displays the requested site's load time, with any additional metrics or color thresholds treated as optional.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100