User Overview
- Endpoint Path:
/api/fresns/v1/user/overview - Method:
GET - Request:
Query
Headers Optional Parameter
| Key | Public Mode (Required) | Private Mode (Required) |
|---|---|---|
| X-Fresns-Aid | required | required |
| X-Fresns-Aid-Token | required | required |
| X-Fresns-Uid | optional | optional |
| X-Fresns-Uid-Token | optional | optional |
Query Params
| Key | Type | Required | Description |
|---|---|---|---|
| uidOrUsername | Number / String | optional | User uid or username |
Request Description
- Unlogged user can also request
- The headers
X-Fresns-Uidand QueryuidOrUsernamecannot be empty, one of them must be passed. - If
uidOrUsernameis passed, then the user overview information is requested, if it is empty, then theX-Fresns-Uiduser panel information is requested. - Query user
uidOrUsernamemust belong to a logged-in account, querying other users is not supported.
Return
json
{
"code": 0,
"message": "ok",
"data": {
"features": [
{
// User Feature Extensions
// Common Data Structure -> Extend Function Info
}
],
"profiles": [
{
// User Profile Extensions
// Common Data Structure -> Extend Function Info
}
],
"conversations": {
"conversationCount": "Number / Conversation count",
"unreadMessages": "Number / Unread conversation message count"
},
"unreadNotifications":{
"all": "Number / Total of all unread below",
"systems": "Number / Unread system notifications",
"recommends": "Number / Unread recommendations",
"likes": "Number / Unread likes",
"dislikes": "Number / Unread dislikes",
"follows": "Number / Unread follows",
"blocks": "Number / Unread blocks",
"mentions": "Number / Unread mentions (at)",
"comments": "Number / Unread comments (replies)",
"quotes": "Number / Unread quotes (reshare)"
},
"draftCount": {
"posts": "Number / Post draft count",
"comments": "Number / Comment draft count"
}
}
}