全量库通用用户检索

本页内容

接口URL：https://open.datastory.com.cn/api/indicator.knowledge.user.list
请求方式：POST
描述：通过该接口可查询全量库的通用用户数据，第一版默认只查询抖音站点用户。

2. 输入参数 #

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 默认值 类型 参数示例 描述
filters 是 RequestKnowledgeUserFilters (见接口示例) 查询过滤条件

3. 输出参数 #

参数名称 必选 类型 参数示例 描述
code 否 integer 0 返回状态码，内部定义
data 否 ResponseDataOfKnowledgeUserInfo (见接口示例) 查询过滤条件
msg 否 string "接口返回成功！" 接口返回信息说明，在接口返回失败时会有
openStrategy 否 boolean false 是否接受缓存
success 否 boolean true 接口返回是否成功

4. 数据结构 #

4.1 RequestKnowledgeUserFilters #

参数名 必选 类型 参数示例 描述
itemIds 否 array ["91682442230"] 站内唯一用户id
secUserItemIds 否 array ["MS4wLjABAAAA1kSDpp6l7e1dT6SwR-De2a4K-ApvlSwyLHlm-J_ZJVU"] 抖音sec_uid
limitSize 否 int 50 查询数据量

4.2 ResponseDataOfKnowledgeUserInfo #

参数名 必选 类型 参数示例 描述
dataset 否 [Array of KnowledgeUserInfo] (请参考数据字典) 返回结果数组
meta 否 array "list" 返回数据格式：list、aggregation、graph
page 否 integer 1 分页查询的页码
pageSize 否 integer "20" 分页查询的单页数据条数
time 否 integer "955" 查询总耗时，单位毫秒
total 否 integer "34500230" 查询数据总量

5. 示例 #

示例1 查看品类下的评论详情 #

检索站内唯一用户id"91682442230"的数据。

输入示例

{
    "filters":{
        "limitSize":50,
        "itemIds": ["91682442230"]
    }
}

输出示例

{
    "success": true,
    "openStrategy": false,
    "code": 0,
    "msg": "接口返回成功！",
    "data": {
        "meta": {
            "datasetType": "list"
        },
        "dataset": [
            {
                "birthday": "2017-01-01",
                "gender": "2",
                "collectionCnt": 9,
                "userName": "活泼可爱的小沫沫",
                "followerCnt": 10,
                "sourceCrawlerId": "24546",
                "crawlerTimestamp": 1572915555000,
                "birthYear": 2017,
                "region": "CN",
                "constellation": "摩羯",
                "updateTimestamp": 1572915573000,
                "catId": "12",
                "friendCnt": 22,
                "id": "9fff5ed66eba429532797fb417cc95e4",
                "videoCnt": 16,
                "cityLevel": "-2",
                "itemId": "91682442230",
                "taskIds": [
                    "1227749"
                ],
                "isVerified": "0",
                "registerId": "290018126",
                "userDesc": "记录宝宝成长的点点滴滴……",
                "friends": [
                    "57058787621",
                    "58140478112",
                    "58513954195",
                    "59041620338",
                    "62632194692",
                    "63318797336",
                    "68635469116",
                    "68718739107",
                    "70183267741",
                    "75328580323",
                    "77555510996",
                    "84990209480",
                    "85264891763",
                    "87643854330",
                    "87700809475",
                    "92743180400",
                    "94446909889"
                ],
                "siteName": "抖音app",
                "avatarUrl": "https://p9-dy.byteimg.com/aweme/1080x1080/5fd3002ba3f2aee8f0d8.jpeg",
                "shareUrl": "https://www.douyin.com/share/user/91682442230",
                "siteId": "1003583",
                "likeCnt": 58
            }
        ],
        "total": 1,
        "time": 43
    }
}

6. 状态码 #

以下仅列出了接口业务逻辑相关的状态码。

状态码 描述