# 获取小程序用户画像分布

调试工具

接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

# 接口说明

# 接口英文名

getUserPortrait

# 功能描述

该接口用于获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中，新增用户数为时间范围内首次访问小程序的去重用户数，活跃用户数为时间范围内访问过小程序的去重用户数。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN

# 云调用

出入参和HTTPS调用相同，调用方式可查看云调用说明文档
接口方法为: openapi.analysis.getUserPortrait

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18、21
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
begin_date	string	是	开始日期。格式为 yyyymmdd
end_date	string	是	结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，允许设置的最大值为昨日。格式为 yyyymmdd

# 返回参数

属性

类型

说明

ref_date

string

时间范围，如："20170611-20170617"

visit_uv_new

object

新用户画像

属性

类型

说明

province

array<object>

分布类型

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

city

array<object>

省份，如北京、广东等

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

genders

array<object>

城市，如北京、广州等

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

platforms

array<object>

性别，包括男、女、未知

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

devices

array<object>

终端类型，包括 iPhone，android，其他

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

ages

array<object>

年龄，包括17岁以下、18-24岁等区间

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

visit_uv

object

活跃用户画像

属性

类型

说明

province

array<object>

分布类型

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

city

array<object>

省份，如北京、广东等

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

genders

array<object>

城市，如北京、广州等

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

platforms

array<object>

性别，包括男、女、未知

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

devices

array<object>

终端类型，包括 iPhone，android，其他

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

ages

array<object>

年龄，包括17岁以下、18-24岁等区间

属性	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# 调用示例

示例说明: HTTPS调用

# 请求数据示例


{
  "begin_date" : "20170611",
  "end_date" : "20170617"
}

# 返回数据示例


{
  "ref_date": "20170611",
  "visit_uv_new": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 215
      }
    ],
    "city": [
     {
        "id": 3102,
        "name": "广州",
        "value": 78
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 2146
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 27642
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 61
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 151
      }
    ]
  },
  "visit_uv": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 1341
      }
    ],
    "city": [
     {
        "id": 3102,
        "name": "广州",
        "value": 234
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 14534
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 21750
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 617
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 3156
      }
    ]
  }
}

示例说明: 云函数调用

# 请求数据示例


const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.analysis.getUserPortrait({
        "beginDate": '20170611',
        "endDate": '20170617'
      })
    return result
  } catch (err) {
    return err
  }
}

# 返回数据示例


{
  "refDate": "20170611",
  "visitUvNew": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 215
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 78
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 2146
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 27642
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 61
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 151
      }
    ]
  },
  "visitUv": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 1341
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 234
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 14534
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 21750
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 617
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 3156
      }
    ]
  },
  "errMsg": "openapi.analysis.getUserPortrait:ok"
}

# 错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口