Skip to content

Commit c73e3ef

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-118: No subject
1 parent 886b1e7 commit c73e3ef

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88
# Introduction
99

1010
{% hint style="info" %}
11-
Docs are up to date through version: `v1.1.0`
11+
Docs are up to date through version: `v1.2.0`
1212
{% endhint %}
1313

1414
<figure><img src=".gitbook/assets/dashboard.png" alt=""><figcaption></figcaption></figure>

api/v1.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A "Bearer Token" is required to authenticate into the API, you can generate toke
2626

2727
***
2828

29-
### List result
29+
### List results
3030

3131
```bash
3232
curl localhost/api/v1/results
@@ -36,12 +36,12 @@ curl localhost/api/v1/results
3636
3737
#### Filtering
3838
39-
You can filter the results response by the fields: `ping`, `download`, `upload`, `healthy`, `status`, `scheduled`, `created_at` and `updated_at`.
39+
You can filter the results response by the fields: `ping`, `download`, `upload`, `healthy`, `status`, `scheduled` and `created_at`. To filter on `created_at` use `start_at`and \`end\_at\`.
4040
4141
Example: filter dates in a range
4242
4343
```bash
44-
curl localhost/api/v1/results?filter[created_at]>=2024-01-01&filter[created_at]<=2024-12-31
44+
curl localhost/api/v1/results?filter[start_at]>=2024-01-01&filter[end_at]<=2024-12-31
4545
-H "Accept: application/json"
4646
-H "Authorization: Bearer yourtokengoeshere"
4747
```
@@ -96,6 +96,22 @@ curl localhost/api/v1/results/latest
9696
9797
9898
99+
***
100+
101+
### Stats
102+
103+
```bash
104+
curl localhost/api/v1/stats
105+
-H "Accept: application/json"
106+
-H "Authorization: Bearer yourtokengoeshere"
107+
```
108+
109+
#### Responses
110+
111+
* 200: OK
112+
113+
114+
99115
***
100116
101117
### Data Dictionary

0 commit comments

Comments
 (0)