Skip to content

Commit bd93e4a

Browse files
committed
updated readme to add key
1 parent aaf1b5b commit bd93e4a

File tree

1 file changed

+10
-52
lines changed

1 file changed

+10
-52
lines changed

README.md

Lines changed: 10 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -239,10 +239,10 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
239239

240240
### Examples
241241

242-
#### 1. Get all available locations
242+
#### 1. Get API available locations
243243

244244
```bash
245-
$ webpagetest locations
245+
$ webpagetest locations -k YOURAPIKEY
246246
```
247247

248248
```javascript
@@ -270,41 +270,10 @@ $ webpagetest locations
270270
}
271271
```
272272

273-
#### 2. Get API available locations
273+
#### 2. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
274274

275275
```bash
276-
webpagetest locations --key 1F2A3K4E5
277-
```
278-
279-
```javascript
280-
{
281-
"response": {
282-
"statusCode": 200, "statusText": "Ok",
283-
"data": {
284-
"location": [
285-
...
286-
{
287-
"id": "SanJose_IE9",
288-
"Label": "San Jose, CA USA (IE 9,Chrome,Firefox)",
289-
"location": "SanJose_IE9",
290-
"Browser": "IE 9",
291-
"PendingTests": {
292-
"p1": 0, "p2": 0, "p3": 0, "p4": 0, "p5": 2, "p6": 2, "p7": 0,
293-
"p8": 0, "p9": 0, "Total": 7, "HighPriority": 2, "LowPriority": 4,
294-
"Testing": 1, "Idle": 0
295-
}
296-
},
297-
...
298-
]
299-
}
300-
}
301-
}
302-
```
303-
304-
#### 3. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
305-
306-
```bash
307-
webpagetest test https://docs.webpagetest.org/api/integrations/ --key 1F2A3K4E5 --location SanJose_IE9
276+
webpagetest test https://docs.webpagetest.org/api/integrations/ -k YOURAPIKEY --location SanJose_IE9
308277
```
309278

310279
```javascript
@@ -323,10 +292,10 @@ webpagetest test https://docs.webpagetest.org/api/integrations/ --key 1F2A3K4E5
323292
}
324293
```
325294

326-
#### 4. Check current test status
295+
#### 3. Check current test status
327296

328297
```bash
329-
webpagetest status 121025_PT_N8K
298+
webpagetest status 121025_PT_N8K -k YOURAPIKEY
330299
```
331300

332301
```javascript
@@ -344,10 +313,10 @@ webpagetest status 121025_PT_N8K
344313
}
345314
```
346315

347-
#### 5. Get test results
316+
#### 4. Get test results
348317

349318
```bash
350-
webpagetest results 121025_PT_N8K
319+
webpagetest results 121025_PT_N8K -k YOURAPIKEY
351320
```
352321

353322
```javascript
@@ -379,23 +348,12 @@ webpagetest results 121025_PT_N8K
379348
}
380349
```
381350

382-
#### 6. Get test waterfall thumbnail from repeat view as data URI
383-
384-
```bash
385-
webpagetest waterfall 121025_PT_N8K --thumbnail --cached --uri
386-
```
387351

388-
```javascript
389-
{
390-
"type": "image/png",
391-
"data": "iVBORw0KGgoAAAANSUhEUgA...RK5CYII="
392-
}
393-
```
394352

395-
#### 7. Get remaining tests count for the account
353+
#### 5. Get remaining tests count for the account
396354

397355
```bash
398-
webpagetest testBalance --key 1F2A3K4E5
356+
webpagetest testBalance -k YOURAPIKEY
399357
```
400358

401359
```javascript

0 commit comments

Comments
 (0)