User:J4/resostats: Difference between revisions

From Resonite Wiki
add basic doc
 
more docs
Line 3: Line 3:
== Accessing the data ==
== Accessing the data ==


Accessing the data is simple, and only one endpoint is available: https://plainapi.resostats.j4.lc/
Accessing the data is simple, and only one endpoint is available:
* https://plainapi.resostats.j4.lc/ - As a plain string formatted as below


This endpoint will return a week worth of data.
This endpoint will return a week worth of data.
Line 21: Line 22:
- Data start
- Data start
</pre>
</pre>
As text:
* The main data body starts with <code>[</code> and ends with <code>]</code>
* Individual data blocks are contained in brackets (<code>[data]</code>) within the body
* The data body is formatted in the following order:
** Number of day (0 to 6)
** Minute of the day (0 to 1440)
** Number of registered players online (inc. headlesses)

Revision as of 16:22, 25 September 2024

This page describes basic documentation for the plain API of Resostats. It is made to provide a week-long history of Resonite stats that is easily parseable with ProtoFlux to make graphs in-game.

Accessing the data

Accessing the data is simple, and only one endpoint is available:

This endpoint will return a week worth of data.

Description of the data

The data is formatted as follows:

[[3,811,276],[3,871,274]]
^^^ ^   ^   ^           ^ Data stop
||| |   |   - Stat delimiter
||| |   - Stats (number of registered players online)
||| - Minute of day (0,1440)
||- Day number (0,6)
|- Data block start delimiter
- Data start

As text:

  • The main data body starts with [ and ends with ]
  • Individual data blocks are contained in brackets ([data]) within the body
  • The data body is formatted in the following order:
    • Number of day (0 to 6)
    • Minute of the day (0 to 1440)
    • Number of registered players online (inc. headlesses)