analysis.getUserPortrait

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

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

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

调用方式：

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
begin_datestring是开始日期。格式为 yyyymmdd
end_datestring是结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，允许设置的最大值为昨日。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
ref_datestring时间范围，如："20170611-20170617"
visit_uv_newObject新用户画像
visit_uvObject活跃用户画像

visit_uv_new 的结构

属性类型说明
indexnumber分布类型
provinceObject省份，如北京、广东等
cityObject城市，如北京、广州等
gendersObject性别，包括男、女、未知
platformsObject终端类型，包括 iPhone，android，其他
devicesObject机型，如苹果 iPhone 6，OPPO R9 等
agesObject年龄，包括17岁以下、18-24岁等区间

province 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

city 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

genders 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

platforms 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

devices 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

ages 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

visit_uv 的结构

属性类型说明
indexnumber分布类型
provinceObject省份，如北京、广东等
cityObject城市，如北京、广州等
gendersObject性别，包括男、女、未知
platformsObject终端类型，包括 iPhone，android，其他
devicesObject机型，如苹果 iPhone 6，OPPO R9 等
agesObject年龄，包括17岁以下、18-24岁等区间

province 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

city 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

genders 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

platforms 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

devices 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

ages 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
access_source_visit_uvnumber该场景访问uv

请求数据示例

  1. {
  2.   "begin_date" : "20170611",
  3.   "end_date" : "20170617"
  4. }

返回数据示例

  1. {
  2.   "ref_date": "20170611",
  3.   "visit_uv_new": {
  4.     "province": [
  5.       {
  6.         "id": 31,
  7.         "name": "广东省",
  8.         "value": 215
  9.       }
  10.     ],
  11.     "city": [
  12.      {
  13.         "id": 3102,
  14.         "name": "广州",
  15.         "value": 78
  16.       }
  17.     ],
  18.     "genders": [
  19.       {
  20.         "id": 1,
  21.         "name": "男",
  22.         "value": 2146
  23.       }
  24.     ],
  25.     "platforms": [
  26.       {
  27.         "id": 1,
  28.         "name": "iPhone",
  29.         "value": 27642
  30.       }
  31.     ],
  32.     "devices": [
  33.       {
  34.         "name": "OPPO R9",
  35.         "value": 61
  36.       }
  37.     ],
  38.     "ages": [
  39.       {
  40.         "id": 1,
  41.         "name": "17岁以下",
  42.         "value": 151
  43.       }
  44.     ]
  45.   },
  46.   "visit_uv": {
  47.     "province": [
  48.       {
  49.         "id": 31,
  50.         "name": "广东省",
  51.         "value": 1341
  52.       }
  53.     ],
  54.     "city": [
  55.      {
  56.         "id": 3102,
  57.         "name": "广州",
  58.         "value": 234
  59.       }
  60.     ],
  61.     "genders": [
  62.       {
  63.         "id": 1,
  64.         "name": "男",
  65.         "value": 14534
  66.       }
  67.     ],
  68.     "platforms": [
  69.       {
  70.         "id": 1,
  71.         "name": "iPhone",
  72.         "value": 21750
  73.       }
  74.     ],
  75.     "devices": [
  76.       {
  77.         "name": "OPPO R9",
  78.         "value": 617
  79.       }
  80.     ],
  81.     "ages": [
  82.       {
  83.         "id": 1,
  84.         "name": "17岁以下",
  85.         "value": 3156
  86.       }
  87.     ]
  88.   }
  89. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.analysis.getUserPortrait

需在 config.json 中配置 analysis.getUserPortrait API 的权限，详情

请求参数

属性类型默认值必填说明
beginDatestring是开始日期。格式为 yyyymmdd
endDatestring是结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，允许设置的最大值为昨日。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
refDatestring时间范围，如："20170611-20170617"
visitUvNewObject新用户画像
visitUvObject活跃用户画像

visitUvNew 的结构

属性类型说明
indexnumber分布类型
provinceObject省份，如北京、广东等
cityObject城市，如北京、广州等
gendersObject性别，包括男、女、未知
platformsObject终端类型，包括 iPhone，android，其他
devicesObject机型，如苹果 iPhone 6，OPPO R9 等
agesObject年龄，包括17岁以下、18-24岁等区间

province 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

city 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

genders 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

platforms 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

devices 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

ages 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

visitUv 的结构

属性类型说明
indexnumber分布类型
provinceObject省份，如北京、广东等
cityObject城市，如北京、广州等
gendersObject性别，包括男、女、未知
platformsObject终端类型，包括 iPhone，android，其他
devicesObject机型，如苹果 iPhone 6，OPPO R9 等
agesObject年龄，包括17岁以下、18-24岁等区间

province 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

city 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

genders 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

platforms 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

devices 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

ages 的结构

属性类型说明
idnumber属性值id
namestring属性值名称，与id对应。如属性为 province 时，返回的属性值名称包括「广东」等。
accessSourceVisitUvnumber该场景访问uv

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4.   try {
  5.     const result = await cloud.openapi.analysis.getUserPortrait({
  6.         beginDate: '20170611',
  7.         endDate: '20170617'
  8.       })
  9.     console.log(result)
  10.     return result
  11.   } catch (err) {
  12.     console.log(err)
  13.     return err
  14.   }
  15. }

返回数据示例

  1. {
  2.   "refDate": "20170611",
  3.   "visitUvNew": {
  4.     "province": [
  5.       {
  6.         "id": 31,
  7.         "name": "广东省",
  8.         "value": 215
  9.       }
  10.     ],
  11.     "city": [
  12.       {
  13.         "id": 3102,
  14.         "name": "广州",
  15.         "value": 78
  16.       }
  17.     ],
  18.     "genders": [
  19.       {
  20.         "id": 1,
  21.         "name": "男",
  22.         "value": 2146
  23.       }
  24.     ],
  25.     "platforms": [
  26.       {
  27.         "id": 1,
  28.         "name": "iPhone",
  29.         "value": 27642
  30.       }
  31.     ],
  32.     "devices": [
  33.       {
  34.         "name": "OPPO R9",
  35.         "value": 61
  36.       }
  37.     ],
  38.     "ages": [
  39.       {
  40.         "id": 1,
  41.         "name": "17岁以下",
  42.         "value": 151
  43.       }
  44.     ]
  45.   },
  46.   "visitUv": {
  47.     "province": [
  48.       {
  49.         "id": 31,
  50.         "name": "广东省",
  51.         "value": 1341
  52.       }
  53.     ],
  54.     "city": [
  55.       {
  56.         "id": 3102,
  57.         "name": "广州",
  58.         "value": 234
  59.       }
  60.     ],
  61.     "genders": [
  62.       {
  63.         "id": 1,
  64.         "name": "男",
  65.         "value": 14534
  66.       }
  67.     ],
  68.     "platforms": [
  69.       {
  70.         "id": 1,
  71.         "name": "iPhone",
  72.         "value": 21750
  73.       }
  74.     ],
  75.     "devices": [
  76.       {
  77.         "name": "OPPO R9",
  78.         "value": 617
  79.       }
  80.     ],
  81.     "ages": [
  82.       {
  83.         "id": 1,
  84.         "name": "17岁以下",
  85.         "value": 3156
  86.       }
  87.     ]
  88.   },
  89.   "errMsg": "openapi.analysis.getUserPortrait:ok"
  90. }