Skip to content

Commit 184f8af

Browse files
tkadlecjefflembeck
authored andcommitted
location filter documentation
1 parent 80abf4d commit 184f8af

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

src/api/reference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,11 @@ Here's an example response from the /getLocations.php endpoint, (truncated for b
761761
</response>
762762
```
763763

764+
You can also optionally pass a `location` parameter referencing an individual location ID to be able to check the status of a single location at a time.
765+
766+
```text
767+
https://webpagetest.org/getLocations.php?f=json&location=ec2-us-east-1
768+
```
764769
### Full list of parameters
765770
::: api-list
766771
- `f` <small>optional</small>
@@ -769,6 +774,8 @@ The format to return. Set to "xml" to request an XML response; set to "json" to
769774
Callback function name. When used with `f=json`, the API will return an JSONP response by wrapping the JSON object with the provided callback name.
770775
- `r` (string)
771776
Request ID. Will echo back in the response object.
777+
- `location` <small>optional</small>
778+
Location ID. If provided, the response will return only the status and information for the specified location.
772779
:::
773780

774781
## Checking Remaining Test Balance

0 commit comments

Comments
 (0)