User Interaction Users
- Endpoint Path:
/api/fresns/v1/user/{uidOrUsername}/interaction/{type} - Method:
GET - Request:
Rest+Query
Headers Optional Parameter
| Key | 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 |
Path Variables
| Key | Type | Required | Description |
|---|---|---|---|
| uidOrUsername | Number / String | required | User uid or username |
| type | String | required | View type likers,dislikers,followers,blockers |
Query Params
| Key | Type | Required | Description |
|---|---|---|---|
| orderDirection | String | optional | Sort by direction asc,desc, Default: desc |
| filterType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned data |
| filterKeys | String | optional | 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
- List Type
type=likersGet the list of users who likeduidOrUsername.type=dislikersGet the list of users who dislikeduidOrUsername.type=followersGet the list of users who followeduidOrUsername.type=blockersGet the list of users who blockeduidOrUsername.
- Sort by direction
orderDirectionThe sort direction is sorted by creation time.
- Judgement of whether to output records
detail.interaction.likePublicRecorddetail.interaction.dislikePublicRecorddetail.interaction.followPublicRecorddetail.interaction.blockPublicRecord
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 -> User Info
}
]
}
}