Skip to content

Comment List by Timelines

  • Endpoint Path: /api/fresns/v1/comment/timelines
  • Method: GET
  • Request: Query

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Query Params

KeyTypeRequiredDescription
typeStringoptionaluser, group, hashtag, geotag
Leave blank to use all
langTagStringoptionalFilter content by lang
contentTypeStringoptionalFilter content by type
sinceCidStringoptionalquery new content after this comment
beforeCidStringoptionalquery old content before this comment
mapIdNumberoptionalMap Service Provider
mapLngStringoptionalMap Longitude (For distance calculation)
mapLatStringoptionalMap Latitude (For distance calculation)
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
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
pageSizeNumberoptionalNumber of items per page (default 15 items)
pageNumberoptionalPage number (default 1)

Request Description

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 -> Comment Info
            }
        ]
    }
}

Released under the Apache-2.0 License