GITBOOK-31: No subject

Author: alexjustesen

README.md

@@ -9,7 +9,7 @@ description: >-
 
 
 {% hint style="info" %}
-These docs are up-to-date for version: `v0.11.2`
+These docs are up-to-date for version: `v0.11.9`
 {% endhint %}
 
 ### Introduction

SUMMARY.md

@@ -2,6 +2,7 @@
 
 * [Introduction](README.md)
 * [Frequently Asked Questions](faqs.md)
+* [Data Dictionary](data-dictionary.md)
 
 ## 🚀 Getting Started
 
@@ -18,6 +19,11 @@
   * [Mail](settings/notifications/mail.md)
   * [Telegram](settings/notifications/telegram.md)
 
+## 🖥 API
+
+* [Getting Started](api/getting-started.md)
+* [Latest Result](api/latest-result.md)
+
 ## 🤹 Contributing
 
 * [Setup Your Environment](contributing/setup-your-environment.md)

api/getting-started.md

@@ -0,0 +1,5 @@
+# Getting Started
+
+### Postman Collection
+
+A [Postman](https://www.postman.com/) collection can be found in the [repository](https://github.com/alexjustesen/speedtest-tracker/blob/main/%F0%9F%90%87%20Speedtest%20Tracker.postman\_collection.json) to test all API endpoints.

api/latest-result.md

@@ -0,0 +1,51 @@
+# Latest Result
+
+### Legacy Endpoints
+
+#### Authentication
+
+No authentication required.
+
+{% swagger method="get" path="" baseUrl="/api/speedtest/latest" summary="Get the latest speedtest result" expanded="false" %}
+{% swagger-description %}
+Provides backwards compatibility for 
+
+[Homepage](https://github.com/benphelps/homepage)
+
+ and 
+
+[Organizr](https://github.com/causefx/Organizr)
+
+ home lab dashboards.
+{% endswagger-description %}
+
+{% swagger-response status="200: OK" description="" %}
+```javascript
+{
+    "message": "ok",
+    "data": {
+        "id": 1,
+        "ping": 11.111,
+        "download": 694.20,
+        "upload": 420.69,
+        "server_id": 12345,
+        "server_host": "host.of.server.com",
+        "server_name": "Name of Server",
+        "url": "https://www.speedtest.net/result/c/slug-to-results",
+        "scheduled": false,
+        "failed": true,
+        "created_at": "2023-03-10T13:17:46.000000Z",
+        "updated_at": "2023-03-10T13:17:46.000000Z"
+    }
+}
+```
+{% endswagger-response %}
+
+{% swagger-response status="404: Not Found" description="" %}
+```javascript
+{
+    "message": "No results found."
+}
+```
+{% endswagger-response %}
+{% endswagger %}

data-dictionary.md

@@ -0,0 +1,21 @@
+# Data Dictionary
+
+### Tables
+
+#### Results
+
+| Field         | Type                 | Description                                  |
+| ------------- | -------------------- | -------------------------------------------- |
+| `id`          | primary key          |                                              |
+| `ping`        | double               | As milliseconds                              |
+| `download`    | unsigned big integer | As bytes                                     |
+| `upload`      | unsigned big integer | As bytes                                     |
+| `server_id`   | integer              | ID of the speedtest server                   |
+| `server_host` | string               | Host/URL of the speedtest server             |
+| `server_name` | string               | Name of the speedtest server                 |
+| `url`         | string               | URL to the result on speedtest.net           |
+| `comments`    | text                 | User added comments                          |
+| `scheduled`   | boolean              | Was the result scheduled?                    |
+| `successful`  | boolean              | Was the result successful?                   |
+| `data`        | json                 | The raw data received from the Speedtest CLI |
+| `created_at`  | timestamp            |                                              |