Skip to content

Group Interaction Users

  • Endpoint Path: /api/fresns/v1/group/{gid}/interaction/{type}
  • 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
gidStringrequiredGroup GID
typeStringrequiredView type likers,dislikers,followers,blockers

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)

Request Description

  • List Type
    • type=likers Get the list of users who liked gid.
    • type=dislikers Get the list of users who disliked gid.
    • type=followers Get the list of users who followed gid.
    • type=blockers Get the list of users who blocked gid.
  • Sort by direction
    • orderDirection The sort direction is sorted by creation time.
  • Judgement of whether to output records
    • detail.interaction.likePublicRecord
    • detail.interaction.dislikePublicRecord
    • detail.interaction.followPublicRecord
    • detail.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
            }
        ]
    }
}

Released under the Apache-2.0 License