mirror of
https://github.com/logto-io/logto.git
synced 2025-01-06 20:40:08 -05:00
chore(core): add dashboard api doc descriptions (#5037)
* chore(core): add dashboard api doc descriptions * chore(core): polish docs --------- Co-authored-by: Gao Sun <gao@silverhand.io>
This commit is contained in:
parent
484b52cb38
commit
3803a1ac23
1 changed files with 52 additions and 0 deletions
52
packages/core/src/routes/dashboard.openapi.json
Normal file
52
packages/core/src/routes/dashboard.openapi.json
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
{
|
||||||
|
"tags": [
|
||||||
|
{
|
||||||
|
"name": "Dashboard",
|
||||||
|
"description": "The APIs that power the dashboard page of Console to show the statistics of the current tenant."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"paths": {
|
||||||
|
"/api/dashboard/users/total": {
|
||||||
|
"get": {
|
||||||
|
"summary": "Get total user count",
|
||||||
|
"description": "Get total user count in the current tenant.",
|
||||||
|
"parameters": [],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Total user count."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/api/dashboard/users/new": {
|
||||||
|
"get": {
|
||||||
|
"summary": "Get new user count",
|
||||||
|
"description": "Get new user count in the past 7 days.",
|
||||||
|
"parameters": [],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "New user count."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/api/dashboard/users/active": {
|
||||||
|
"get": {
|
||||||
|
"summary": "Get active user data",
|
||||||
|
"description": "Get active user data, including daily active user (DAU), weekly active user (WAU) and monthly active user (MAU). It also includes an array of DAU in the past 30 days.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"in": "query",
|
||||||
|
"name": "date",
|
||||||
|
"description": "The date to get active user data."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Active user data object."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue