Skip to content

Commit 9e8e513

Browse files
Added API Documentation
1 parent c99b179 commit 9e8e513

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,20 @@ public class PingCommand extends SlashCommand {
5656

5757
For more information on how this works, visit the [DIH4JDA Wiki!](https://github.com/DynxstyGIT/DIH4JDA/wiki)
5858

59+
# API Documentation
60+
61+
### `GET guilds/{guild_id}/metrics`
62+
- Responds with guild-specific metrics, such as the member- and (approximate) online count.
63+
64+
### `GET guilds/{guild_id}/users/{user_id}`
65+
- Responds with the specified users' profile which includes some basic info, such as the users' name and avatar url, but also their recent warns, their current help experience and more!
66+
67+
### `GET guilds/{guild_id}/leaderboard/qotw?page=1`
68+
- A paginated endpoint which responds with an ordered list of users, based on their QOTW points.
69+
70+
### `GET guilds/{guild_id}/leaderboard/experience?page=1`
71+
- A paginated endpoint which responds with an ordered list of users, based on their help channel experience.
72+
5973
# Credits
6074

6175
Inspiration we took from other communities:

0 commit comments

Comments
 (0)