You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/webpagetest-faqs.md
+77-42Lines changed: 77 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,90 @@
1
1
---
2
-
title: 'WebPageTest API FAQs'
2
+
title: 'WebPageTest FAQs'
3
3
eleventyNavigation:
4
-
parent: API
5
-
key: FAQs
4
+
key: WebPageTest FAQs
6
5
order: 3
7
6
---
8
-
# WebPageTest API FAQs
9
-
This page answers frequently asked questions about account, test options and billing for WebPageTest API. If you are unable to find information about your specific WPT API related question, please submit your question via the **Contact Support** option on **My Account** once you’ve signed into your WebPageTest account. You can also submit your question on our [forums](https://forums.webpagetest.org). Be careful to not share any sensitive account or payment related information there.
7
+
# WebPageTest FAQs
8
+
This page answers frequently asked questions about account, test options and billing for WebPageTest Pro. If you are unable to find information about your specific WPT Pro related question, please submit your question via the *Contact Support* option on [*My Account*](https://www.webpagetest.org/account) once you’ve signed into your WebPageTest account. You can also submit your question on our [forums](https://forums.webpagetest.org). Be careful to not share any sensitive account or payment related information there.
10
9
11
10
## Running Tests
12
11
:::faqs
12
+
### What is WebPageTest Pro and what is WebPageTest Starter?
13
+
**WebPageTest Pro** is our premium, paid subscription plan that unlocks powerful functionality and features for WebPageTest including, but not limited to: bulk testing, premium testing locations, high priority in testing queues, the WebPageTest API, experiments, dedicated support and private tests.
14
+
15
+
**WebPageTest Starter** is our free plan available to all users to run WebPageTest runs that provide all the performance metrics that WebPageTest has provided for years plus access to the new Opportunities report.
16
+
17
+
Both WebPageTest Starter and Pro give you access to save your Test History for 13 months.
13
18
14
19
### How do you define a test run?
15
-
A test run on WebPageTest is defined as a single run within a test set up to measure webpage performance on a specific browser and location. For example, if you run a 5-run test with **Repeat View**, then that counts as 10 test runs.
20
+
*FOR ALL PLANS*, a test on WebPageTest is comprised of one or more test runs. A test run is defined as a single page load within a test. Here are a few examples:
21
+
22
+
- A test from a single browser and location, with 3 test runs, first view only, counts as three test runs. (3 runs * 1 load per run)
23
+
- A test from a single browser and location, with 5 test runs, first and repeat views for each run, counts as 10 test runs (5 runs * 2 loads per run)
24
+
- A test from a single browser and location, with 4 tests runs, first and repeat views for each run, and an additional Lighthouse run, counts as 9 test runs ( (4 runs * 2 loads per run) + 1 Lighthouse run)
25
+
- An experiment from a single browser and location, with 2 test runs, first view only for each run, counts as 4 runs (2 runs * 2 tests (one for the experiment, one for the control run).
26
+
27
+
### What countries and browsers do you support with WebPageTest?
28
+
WebPageTest is always up-to-date on the current version of every browser and you can test on Chrome (stable, beta, canary), Firefox (stable, beta, ESR), Microsoft Edge (dev) and Brave.
29
+
30
+
**WebPageTest Starter** gives you access to 30 locations worldwide, including mainland China.
31
+
32
+
**With WebPageTest Pro**, you get access to 11 more premium locations. WebPageTest Pro also supports mobile emulation testing. You can test mobile content by emulating an Android browser by passing `mobile=1` as an API option.
33
+
34
+
### What are Opportunities and Experiments?
35
+
Opportunities and Experiments are a powerful combination that will let you quickly identify areas of improvement for your website and test the impact of any relevant optimizations without ever having to write a line of code.
36
+
37
+
Opportunities are recommendations that are broken down into three categories:
38
+
39
+
- Quickness
40
+
- Usability
41
+
- Resilience
42
+
43
+
Opportunities are a free feature of WebPageTest provided to all users.
44
+
45
+
For every opportunity, you will be presented with some combination of tips (suggestions for what to do to improve) and experiments (the ability to apply optimizations right within the WebPageTest sandbox). When you choose to run an experiment, WebPageTest applies the optimization in our sandbox environment and then runs a test (alongside a control test which uses our sandbox environment without applying the optimization), and presents you with results showing you how significant, or insignificant, the improvement was.
46
+
47
+
Experiments are a paid feature and are only available to WebPageTest Pro subscribers.
48
+
49
+
### What is Bulk Testing?
50
+
Bulk Testing lets you quickly run tests using the same settings, against a large number of URLs all at once. You are able to either provide a list of URLs or upload a CSV of URLs to test. Each URL will be tested using the settings you have defined, and the final results for each test will be presented as usual for further analysis. *Bulk Testing is only available to WebPageTest Pro subscribers.*
51
+
52
+
### What is a Private Test?
53
+
With WebPageTest Pro, you have the ability to run a private test. A private test is a test that can only be accessed by the account owner—if anyone who is not the account owner tries to access the test information, they will be presented with an error. *Private Tests are only available to WebPageTest Pro subscribers.*
54
+
55
+
### How long will my test results be stored?
56
+
You will have access to all the tests you run via as part of both WebPageTest Pro and Starter plans for 13 months. This also enables you to monitor performance over time and look at year-over-year performance analyses and trends.
57
+
58
+
### What metrics can I access with Pro?
59
+
WebPageTest provides accurate, in-depth analysis of your page with hundreds of metrics collected on every run, as well as the ability to set and define custom metrics by running JavaScript at the end of any test. You also get powerful visual features such as the film strip view as well as video capture.
60
+
61
+
### Is there a daily limit for the test runs?
62
+
There is a monthly limit on the total tests you can run with the WebPageTest Pro and WebPageTest Starter Plans, based on the subscription plan you choose. There is currently no daily limit on top of that monthly limit.
63
+
64
+
### Do you provide any developer integrations that I can use with WebPageTest Pro?
65
+
There are several existing first-party integrations built with the WebPageTest API, including our [GitHub Action](https://docs.webpagetest.org/integrations/#webpagetest-github-action), [Slack Bot](https://docs.webpagetest.org/integrations/#webpagetest-slack-bot), [Visual Studio Code Extension](https://docs.webpagetest.org/integrations/#webpagetest-visual-studio-code-extension), and our [Node.js API wrapper](https://docs.webpagetest.org/integrations/#webpagetest-api-wrapper-for-nodejs) (the preferred way to interact with our API).
66
+
67
+
There are also numerous integrations [built and maintained by our community members](https://docs.webpagetest.org/integrations/#community-built-integrations).
16
68
17
-
### Do you have a free trial option to test the API?
18
-
We do not have a free trial option since the API gives you all the metrics you see on the JSON today for any test you run on www.webpagetest.org. Note that our annual subscription plans offer a **25% savings** over monthly subscriptions.
69
+
You can find more ideas of how to use the API in our[] constantly growing recipes repository](https://github.com/WebPageTest/WebPageTest-API-Recipes).
70
+
71
+
### Can I add more users to my WPT Pro Pro or Starter account?
72
+
Currently, we only support one user account to sign in and set up your account for WebPageTest Starter or to purchase the WebPageTest Pro subscriptions. However, if you use the WebPageTest API under the Pro subscription, you can generate up to 30 API Consumer keys for multiple use cases and teams, from a single WebPageTest Pro account. Generate a new key by clicking on “+ New API Key” in your account page.
73
+
74
+
We have plans to support adding multiple users and defining roles in the future.
75
+
76
+
### Is there a free trial where I can test WebPageTest Pro?
77
+
We provide 1 free experiment per test for you to check out WebPageTest Experiments. You can also run Experiments from our in-house test page called The Metric Times where we have builti in anti-patterns for easy testing.
78
+
79
+
We do not have a free trial option apart from the above 2 options, since WebPageTest Pro gives you all the [metrics](https://www.webpagetest.org/themetrictimes/index.php) (except for the option to run the experiments) you see on a typical WebPageTest test result page as well as in the JSON today for any test you run on www.webpagetest.org.
80
+
81
+
For example, you can:
19
82
- Run a test on www.webpagetest.org.
20
-
- Click on **'View JSON'** under **Export Files** on any test result. You can see the metrics that a test run via the WebPageTest API will provide. Customize what metrics you want to pull in and where.
83
+
- Click on **'View JSON'** under **Export Files** on any test result. You can see the metrics that a test run via the WebPageTest API will provide.
21
84
- You can also check out our [API integrations](https://docs.webpagetest.org/integrations/) to integrate WebPageTest into your developer workflow, build visualizations, set performance budgets, see code changes and more.
22
85
86
+
[Contact us](https://www.product.webpagetest.org/contact) if you want to discuss a custom plan or run more than 20,000 test runs a month.
87
+
23
88
Here are a few more resources you may find helpful:
24
89
-[Getting started on API](https://docs.webpagetest.org/api) which also includes information about all the metrics you can pull with the API
25
90
-[External post](https://css-tricks.com/webpagetest-api/) by CSS Tricks about running tests using the API
@@ -32,48 +97,18 @@ This is helpful to see how representative the test is of the Chrome users' exper
32
97
33
98
Check out the [Guide to Core Web Vitals](https://product.webpagetest.org/core-web-vitals) for more information as well as tips to tackle Core Web Vitals issues.
34
99
35
-
### What countries and browsers do you support with the WebPageTest API?
36
-
With WebPageTest API, you can test across 30 locations worldwide, including mainland China.
37
-
38
-
WebPageTest API is always up-to-date on the current version of every browser and you can test on Chrome (stable, beta, canary), Firefox (stable, beta, ESR), Microsoft Edge (dev) and Brave.
39
-
40
-
WebPageTest API also supports mobile emulation testing. You can test mobile content by emulating an Android browser by passing **“mobile=1”** as an API option.
41
-
42
-
### Does the API support testing on mobile devices?
100
+
### Does WebPageTest support testing on mobile devices?
43
101
For mobile testing, we currently recommend using mobile emulation by passing **"mobile=1"** as an API parameter. If you are using the [API wrapper for NodeJS](https://docs.webpagetest.org/integrations/#webpagetest-api-wrapper-for-nodejs), then you can use **emulateMobile: true**
44
102
45
-
### What metrics can I access with the API?
46
-
You can access [all the performance metrics](/metrics) that you would when you run a manual test on WebPageTest, as well as the film strip view and video capture. WebPageTest API also gives you additional metrics that are only currently exposed in the JSON and XML results, not in the UI itself.
47
-
48
-
### How long will my test results be stored?
49
-
You will have access to all the tests you run via WebPageTest API for 13 months. This also enables you to look at year-over-year performance analyses and trends.
50
-
51
-
### Is there a daily limit for the test runs?
52
-
There is a monthly limit on the total tests you can run with the WebPageTest API, based on the subscription plan you choose. There is currently no daily limit on top of that monthly limit.
53
-
54
103
### How can I see how many tests I have remaining?
55
104
You can always see how many tests you have remaining in your current month by looking at the **Remaining Runs** value under the **Subscription Plan** section of your **My Account** page.
56
105
57
106
You can also programmaticaly check how many tests you have remaining by using the [testBalance.php](/api/reference/#checking-remaining-test-balance) endpoint of the API itself.
58
107
59
-
### Do you provide any integrations that I can use with the API?
60
-
We currently support the following integrations:
61
-
62
-
-**[WebPageTest API Wrapper for NodeJS](https://github.com/marcelduran/webpagetest-api)**
63
-
An npm package that wraps WebPageTest API for NodeJS as a module and a command-line tool
A GitHub Action that lets you automatically run tests against WebPageTest on code changes, set and enforce performance budgets, and have performance data automatically added to your pull requests to move the performance conversation directly into your existing development workflow.
A Slack bot that lets you run tests against WebPageTest from within Slack. Once the tests are complete, a copy of the waterfall and a link to the full results will be posted in your Slack channel, helping you to easily troubleshoot and diagnose performance issues directly from your Slack development channels.
The Visual Studio Code(Vscode) Extension for WebPageTest lets you run tests against WebPageTest from within Vscode, helping you to easily troubleshoot and diagnose performance issues directly from Vscode and possibly refactor the code if needed.
70
-
71
-
There are also several existing integrations built by our community members that you can try out to build on top of WebPageTest. [Check out some of them here.](/integrations/#community-built-integrations)
72
-
:::
73
-
74
108
### Are there any code examples I can see for how to use the API?
75
109
We have an [ever-growing collection of common recipes for the WebPageTest API available on GitHub](https://github.com/WebPageTest/WebPageTest-API-Recipes). If you don't see the recipe you're looking for, [file an issue](https://github.com/WebPageTest/WebPageTest-API-Recipes/issues) and we'll see if it's something we can add.
76
110
111
+
:::
77
112
78
113
## Billing
79
114
:::faqs
@@ -114,7 +149,7 @@ Here are steps to ensure your payment goes through:
114
149
You will be charged at the time of purchase for the subscription plan you chose. Please allow additional time for your financial institution to post the charge on your bank account.
115
150
116
151
### What do I do if I have any immediate billing questions or if I need to speak with someone regarding charges on my account?
117
-
Currently, we provide email support for all your API related questions around account, API tests, and billing. You can contact us anytime. Simply select **Contact Support** on the top right section of **My Account** and submit your query. Our support specialist will get back to you within 2-3 business days.
152
+
Currently, we provide email support for all your WebPageTest Pro related questions around account, API tests, and billing. You can contact us anytime. Simply select **Contact Support** on the top right section of **My Account** and submit your query. Our support specialist will get back to you within 2-3 business days.
118
153
119
154
### What do I do if I did not sign up for your service and suspect a fraudulent charge has been made on my credit card?
120
155
Please contact our support team and provide us with your name, contact information, date of the charge, and the amount. Select **Contact Support** on the top right section of **My Account** and submit your query.
0 commit comments