Skip to content

Commit 57b91a2

Browse files
committed
udpate readme api dic
1 parent 2dad8f9 commit 57b91a2

File tree

1 file changed

+52
-3
lines changed

1 file changed

+52
-3
lines changed

README.md

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The following parameters can be used to filter the data:
6969

7070
```bash
7171
curl --request GET \
72-
--url 'https://dev-gw-2vzgiib6.uk.gateway.dev/v1/categories?category=Domain%20parking%2CCI'
72+
--url 'https://d{{HOST}}/v1/categories?category=Domain%20parking%2CCI'
7373
```
7474

7575
```json
@@ -94,7 +94,7 @@ curl --request GET \
9494

9595
```bash
9696
curl --request GET \
97-
--url 'https://dev-gw-2vzgiib6.uk.gateway.dev/v1/categories?onlyname=true'
97+
--url 'https://{{HOST}}/v1/categories?onlyname=true'
9898
```
9999

100100
```json
@@ -126,7 +126,7 @@ The following parameters can be used to filter the data:
126126

127127
```bash
128128
curl --request GET \
129-
--url 'https://dev-gw-2vzgiib6.uk.gateway.dev/v1/cwv?start=2023-01-01&end=2023-09-01&geo=Uruguay&technology=DomainFactory&rank=ALL'
129+
--url 'https://{{HOST}}/v1/cwv?start=2023-01-01&end=2023-09-01&geo=Uruguay&technology=DomainFactory&rank=ALL'
130130

131131
```
132132

@@ -156,6 +156,55 @@ curl --request GET \
156156

157157
```
158158

159+
### `GET /lighthouse`
160+
161+
#### Parameters
162+
163+
The following parameters can be used to filter the data:
164+
165+
- `technology` (`required`): A comma-separated string representing the technology name(s).
166+
- `geo` (`required`): A string representing the geographic location.
167+
- `rank` (`required`): An string representing the rank.
168+
- `start` (optional): A string representing the start date in the format `YYYY-MM-DD`.
169+
- `end` (optional): A string representing the end date in the format `YYYY-MM-DD`.
170+
171+
#### Response
172+
173+
```bash
174+
curl --request GET \
175+
--url 'https://{{HOST}}/v1/lighthouse?start=2023-01-01&end=2023-09-01&geo=Maldives&technology=Oracle%20HTTP%20Server%2C%20Google%20Optimize%2C%20Searchanise&rank=ALL'
176+
```
177+
178+
Returns a JSON object with the following schema:
179+
180+
```json
181+
[
182+
{
183+
"geo": "Maldives",
184+
"date": "2023-06-01",
185+
"rank": "ALL",
186+
"technology": "Oracle HTTP Server",
187+
"lighthouse": [
188+
{
189+
"mobile": {
190+
"median_score": 0.945
191+
},
192+
"desktop": null,
193+
"name": "accessibility"
194+
},
195+
{
196+
"mobile": {
197+
"median_score": 0.915
198+
},
199+
"desktop": null,
200+
"name": "best_practices"
201+
},
202+
...
203+
]
204+
}
205+
]
206+
```
207+
159208

160209
### `GET /technologies`
161210

0 commit comments

Comments
 (0)