User Mark List
- Endpoint Path:
/api/v2/user/{uidOrUsername}/mark/{markType}/{listType} - Method:
GET - Request:
Rest+Query
Headers Optional Parameter
| Parameter Name | Public Mode (Required) | Private Mode (Required) |
|---|---|---|
| X-Fresns-Aid | optional | required |
| X-Fresns-Aid-Token | optional | required |
| X-Fresns-Uid | optional | required |
| X-Fresns-Uid-Token | optional | required |
Rest Params
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| uidOrUsername | Number / String | required | User uid or username |
| markType | String | required | like,dislike,follow,block |
| listType | String | required | users,groups,hashtags,posts,comments |
Query Params
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| orderDirection | String | optional | Sort by direction asc,desc, Default: desc |
| whitelistKeys | String | optional | Whitelist key names, only returns key-value pairs for the given key names Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| blacklistKeys | String | optional | Blacklist key names, removes specified key-value pairs from the returned data Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| pageSize | Number | optional | Number of items per page (default 15 items) |
| page | Number | optional | Page number (default 1) |
Request Description
- Content marked by they actions. Get the content marked by the user
uidOrUsername. - Ordered by record time, e.g., for posts, it is sorted by the marking time, not the post creation time.
- The interface will output data based on the configuration table setting
Operations > Interaction Configuration > View Others' Content Settings.- Like configuration
markType=likelistType=usersGet the list of users they liked, the configuration keyit_like_usersdetermines whether to output.listType=groupsGet the list of groups they liked, the configuration keyit_like_groupsdetermines whether to output.listType=hashtagsGet the list of topics they liked, the configuration keyit_like_hashtagsdetermines whether to output.listType=postsGet the list of posts they liked, the configuration keyit_like_postsdetermines whether to output.listType=commentsGet the list of comments they liked, the configuration keyit_like_commentsdetermines whether to output.
- Dislike configuration
markType=dislikelistType=usersGet the list of users they disliked, the configuration keyit_dislike_usersdetermines whether to output.listType=groupsGet the list of groups they disliked, the configuration keyit_dislike_groupsdetermines whether to output.listType=hashtagsGet the list of topics they disliked, the configuration keyit_dislike_hashtagsdetermines whether to output.listType=postsGet the list of posts they disliked, the configuration keyit_dislike_postsdetermines whether to output.listType=commentsGet the list of comments they disliked, the configuration keyit_dislike_commentsdetermines whether to output.
- Follow configuration
markType=followlistType=usersGet the list of users they followed, the configuration keyit_follow_usersdetermines whether to output.listType=groupsGet the list of groups they followed, the configuration keyit_follow_groupsdetermines whether to output.listType=hashtagsGet the list of topics they followed, the configuration keyit_follow_hashtagsdetermines whether to output.listType=postsGet the list of posts they followed, the configuration keyit_follow_postsdetermines whether to output.listType=commentsGet the list of comments they followed, the configuration keyit_follow_commentsdetermines whether to output.
- Block configuration
markType=blocklistType=usersGet the list of users they blocked, the configuration keyit_block_usersdetermines whether to output.listType=groupsGet the list of groups they blocked, the configuration keyit_block_groupsdetermines whether to output.listType=hashtagsGet the list of topics they blocked, the configuration keyit_block_hashtagsdetermines whether to output.listType=postsGet the list of posts they blocked, the configuration keyit_block_postsdetermines whether to output.listType=commentsGet the list of comments they blocked, the configuration keyit_block_commentsdetermines whether to output.
- Like configuration
- If
uidOrUsernameis the logged-in user themselves, the above configuration is invalid, and the data is output directly, meaning that when viewing their own content, the switch is ignored. orderDirectionThe sorting direction is based on the creation time.
Return
json
{
"code": 0,
"message": "ok",
"data": {
"pagination": {
"total": "Number / How much data in total",
"pageSize": "Number / How much data on each page",
"currentPage": "Number / Current page number",
"lastPage": "Number / Last page number"
},
"list": [
{
// Common Data Structure -> Structural information for the corresponding content type
}
]
}
}