Skip to content

User Mark List

  • Endpoint Path: /api/fresns/v1/user/{uidOrUsername}/mark/{markType}/{listType}
  • Method: GET
  • Request: Rest + Query

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Path Variables

KeyTypeRequiredDescription
uidOrUsernameNumber / StringrequiredUser uid or username
markTypeStringrequiredlike,dislike,follow,block
listTypeStringrequiredusers,groups,hashtags,geotags,posts,comments

Query Params

KeyTypeRequiredDescription
orderDirectionStringoptionalSort by direction asc,desc, Default: desc
filterTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
filterKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
pageSizeNumberoptionalNumber of items per page (default 15 items)
pageNumberoptionalPage number (default 1)

Post list Query Params

KeyTypeRequiredDescription
filterGroupTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the group parameter in the returned result
filterGroupKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterHashtagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the hashtags parameter in the returned result
filterHashtagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterGeotagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the geotag parameter in the returned result
filterGeotagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterAuthorTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the author parameter in the returned result
filterAuthorKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterQuotedPostTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the quotedPost parameter in the returned result
filterQuotedPostKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewLikeUserTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewLikeUsers parameter in the returned result
filterPreviewLikeUserKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewCommentTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewComments parameter in the returned result
filterPreviewCommentKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays

Comment list Query Params

KeyTypeRequiredDescription
filterHashtagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the hashtags parameter in the returned result
filterHashtagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterGeotagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the geotag parameter in the returned result
filterGeotagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterAuthorTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the author parameter in the returned result
filterAuthorKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewLikeUserTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewLikeUsers parameter in the returned result
filterPreviewLikeUserKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewCommentTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewComments parameter in the returned result
filterPreviewCommentKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterReplyToPostTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the replyToPost parameter in the returned result
filterReplyToPostKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterReplyToCommentTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the replyToComment parameter in the returned result
filterReplyToCommentKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays

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.
  • Judgement of whether to output records
    • Like configuration markType=like
      • listType=users Get the list of users they liked, the config key profile_likes_users_enabled
      • listType=groups Get the list of groups they liked, the config key profile_likes_groups_enabled
      • listType=hashtags Get the list of hashtags they liked, the config key profile_likes_hashtags_enabled
      • listType=geotags Get the list of geotags they liked, the config key profile_likes_geotags_enabled
      • listType=posts Get the list of posts they liked, the config key profile_likes_posts_enabled
      • listType=comments Get the list of comments they liked, the config key profile_likes_comments_enabled
    • Dislike configuration markType=dislike
      • listType=users Get the list of users they disliked, the config key profile_dislikes_users_enabled
      • listType=groups Get the list of groups they disliked, the config key profile_dislikes_groups_enabled
      • listType=hashtags Get the list of hashtags they disliked, the config key profile_dislikes_hashtags_enabled
      • listType=geotags Get the list of geotags they disliked, the config key profile_dislikes_geotags_enabled
      • listType=posts Get the list of posts they disliked, the config key profile_dislikes_posts_enabled
      • listType=comments Get the list of comments they disliked, the config key profile_dislikes_comments_enabled
    • Follow configuration markType=follow
      • listType=users Get the list of users they followed, the config key profile_following_users_enabled
      • listType=groups Get the list of groups they followed, the config key profile_following_groups_enabled
      • listType=hashtags Get the list of hashtags they followed, the config key profile_following_hashtags_enabled
      • listType=geotags Get the list of geotags they followed, the config key profile_following_geotags_enabled
      • listType=posts Get the list of posts they followed, the config key profile_following_posts_enabled
      • listType=comments Get the list of comments they followed, the config key profile_following_comments_enabled
    • Block configuration markType=block
      • listType=users Get the list of users they blocked, the config key profile_blocking_users_enabled
      • listType=groups Get the list of groups they blocked, the config key profile_blocking_groups_enabled
      • listType=hashtags Get the list of hashtags they blocked, the config key profile_blocking_hashtags_enabled
      • listType=geotags Get the list of geotags they blocked, the config key profile_blocking_geotags_enabled
      • listType=posts Get the list of posts they blocked, the config key profile_blocking_posts_enabled
      • listType=comments Get the list of comments they blocked, the config key profile_blocking_comments_enabled
  • If uidOrUsername is 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.
  • orderDirection The 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
            }
        ]
    }
}

Released under the Apache-2.0 License