mirror of
https://github.com/m1k1o/neko.git
synced 2025-05-01 03:16:22 +02:00
63 lines
No EOL
4.4 KiB
Text
63 lines
No EOL
4.4 KiB
Text
---
|
|
id: stats
|
|
title: "Get Stats"
|
|
description: "Retrieve statistics about the server and user sessions."
|
|
sidebar_label: "Get Stats"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVV9tu20YQ/ZXBBihagqbUpE96cx21NXJpYbnNQ2IYI3JEbrTcZXaWclVD/17MLmnRiosWvTz0yfJezsw5Ozfeq4A1q8V7VZMlj0bd5KoiLr3ugnZWLdQVBa9pR8ABg+agSwZcuz5AaAiY/I48oK2gZ/LAxKyd5ULlynXkUVAuK7VQcp1Vrjxx5ywTq8W9ej6fy5/HFldHQ34wXgH3ZUnMm96YvYCXzgayQW5j1xldRkuzjywQ94rLhlqUX2HfkVoot/5IZVC56rz4FXRyoEG+bRyHycm1c4bQqlMhLm0lVohBb4S7J9AMCHIdyt57skF8O+RKlm51NQHl4LWtP8O8bgguX4KLgCNIRMzFCtqEl1S+5YA+UHWL4SnkjfOt7KgKA50F3dKT5mSDA7Yd3DVkp484wEeLwQU0t/KkPLGlbaCa/NO4cgNs367JC6F4F0pnLZUjqkEOEfTW0Cb86zwEPoWhwD9SMPHBqtX27xJKl59iFHf+Q0oR/5STkNLB0JAwrA4HWftm/vXnGSXgnj71xCH+1Z44CYV9aMiGIX3+xcRqiRlr+vMUeEkBtaEKyHvnYbj3mOBStt4MiCPPF0/zHIK5txV5Ds5VUceBfQ7rXiTY9EwMwUX+zuvfCHT437A/5Kql0DgpqzVF6xgatVAz7PRsLLRJCCnupzK9diWaQSiVq94btVBNCN1iNjOyJwVo8WI+n6vDjQCVvddhH5G+JfTkz3ux9/7mkN+rC+e2mqYr125L9mFhgrAS+ZJC01sPImGnX9Fe5UqLm2U8onJlsZXdt8tXP96ulqvV5Y9vPxPy/FEgQ8/a1oBjP4KEFVN2yuDBsrAXzaKD0gTiob9qJUFCEN7RxkSBPyD3qSe/P3KLV/+quXgYOmSmClB6UESDDj22FMin+NF246L9IY7e0tbB+U+XKlcSGMnEi2JezD8zHI/GHHlH66vri9jg39F65cotBVgT64oYrpara0GUTOq82+lKMg1NLHEg/zrg4AlbbescpNp6LIPeEZTOGFy7NCDkEd9T6wJBRbwNroNNb0vZRKPDvvhgP9hnz57BhfME11Q21hlXa2LZOIMs+yVaW43WwEkVSN5n2QcLcAaRlaEdeayJIcvGbdg4f3Q8B+PuzgwGsuU+h0bXzdmnProxcBJvsa/0hF2RTLyi/dqhr+KR1vVMQDuygQE9QfBoudUhUJX8i90XWxplHpqLPLa4xIStIeajcs4WI+Er8fdahF7pWlSS2LAVXLi27e0YM6MM6eVGJSL1cUnGmF5CKZo8gmk7uvUlFXWRPySTNKm10dy0ZEMOlxdLKNFWWrob0K9lg7amrwqAZOx1fO8GwxGh7+Qsp3ffDprNkl4bNGaN5TYq1qCtzKjWg89HDcYAFNeXO/L70IjrS8N05HqSRl/AanDjDVqsSVhkGZzBSsoUPdUYo5+j89EnefKRYJZdOdfGMz/L3RPYC08YYgK0rtKbffwph6XZeGei2MlonHElm7xzLU8MvByS4iJd4Qh8Xn3sWZCBS08kVc5udN2npOIcWnFE9rd/FJbFaGC150At/EBoQgNfwBuZvMtkZ/gEiIbSsSYdKxsqtxxBH4Z9NKAt67oJyf+Utj+4O7gMcG4MvHN+y3DtapIhWg58XUxzMT05Q0uVxmOCxSfOspPykg95KC5UGDDLig/2eXES4GS5l5EHIcs6KX0cYuSudaU9DVUmy07Tb1IGphmYeL0oJvGXZWP9k7Ky0ZbOao/a0sMjZ1mK4ck7D1VPQufRw8Xo/k6mAal1VZwQOJepJfaYWDTkOygGfuXKXiJtvKlyZXRJluPwMXSX8w7LhuB5rPSP2v3d3V2Bcbdwvp4NV3n2+vJi+Xa1PHtezIsmtCY2lM5xaNFOgL+nAKth3njUQe6Pk9Q/+IIcOmegX8OsM6it9Nbo//0w8ryXtiqNOzpxkz69ZPn+fo1MP3tzOMhyareL9ze52qHXuJaOKNOKaggr8nG22dJexCpL6mSo2qHpU+M+GQRlpHkYwL5fXqvD4XcfwFHI
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/v3/api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Get Stats"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/stats"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve statistics about the server and user sessions.
|
|
|
|
<ParamsDetails
|
|
parameters={undefined}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Statistics retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"has_host":{"type":"boolean","description":"Indicates if there is a host currently."},"host_id":{"type":"string","description":"The ID of the current host, if any."},"server_started_at":{"type":"string","format":"date-time","description":"The timestamp when the server started."},"total_users":{"type":"integer","description":"The total number of users connected."},"last_user_left_at":{"type":"string","format":"date-time","description":"The timestamp when the last user left, if any."},"total_admins":{"type":"integer","description":"The total number of admins connected."},"last_admin_left_at":{"type":"string","format":"date-time","description":"The timestamp when the last admin left, if any."}},"title":"Stats"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|