analysis.getUserPortrait
本接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中,新增用户数为时间范围内首次访问小程序的去重用户数,活跃用户数为时间范围内访问过小程序的去重用户数。
调用方式:
HTTPS 调用
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
begin_date | string | 是 | 开始日期。格式为 yyyymmdd | |
end_date | string | 是 | 结束日期,开始日期与结束日期相差的天数限定为0/6/29,分别表示查询最近1/7/30天数据,允许设置的最大值为昨日。格式为 yyyymmdd |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
ref_date | string | 时间范围,如:”20170611-20170617” |
visit_uv_new | Object | 新用户画像 |
visit_uv | Object | 活跃用户画像 |
visit_uv_new 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
province | Object | 省份,如北京、广东等 |
city | Object | 城市,如北京、广州等 |
genders | Object | 性别,包括男、女、未知 |
platforms | Object | 终端类型,包括 iPhone,android,其他 |
devices | Object | 机型,如苹果 iPhone 6,OPPO R9 等 |
ages | Object | 年龄,包括17岁以下、18-24岁等区间 |
province 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
city 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
genders 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
platforms 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
devices 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
ages 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
visit_uv 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
province | Object | 省份,如北京、广东等 |
city | Object | 城市,如北京、广州等 |
genders | Object | 性别,包括男、女、未知 |
platforms | Object | 终端类型,包括 iPhone,android,其他 |
devices | Object | 机型,如苹果 iPhone 6,OPPO R9 等 |
ages | Object | 年龄,包括17岁以下、18-24岁等区间 |
province 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
city 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
genders 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
platforms 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
devices 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
ages 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
access_source_visit_uv | number | 该场景访问uv |
请求数据示例
{
"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
}
]
}
}
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过
wx-server-sdk
使用。
接口方法
openapi.analysis.getUserPortrait
需在
config.json
中配置analysis.getUserPortrait
API 的权限,详情
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
beginDate | string | 是 | 开始日期。格式为 yyyymmdd | |
endDate | string | 是 | 结束日期,开始日期与结束日期相差的天数限定为0/6/29,分别表示查询最近1/7/30天数据,允许设置的最大值为昨日。格式为 yyyymmdd |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
refDate | string | 时间范围,如:”20170611-20170617” |
visitUvNew | Object | 新用户画像 |
visitUv | Object | 活跃用户画像 |
visitUvNew 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
province | Object | 省份,如北京、广东等 |
city | Object | 城市,如北京、广州等 |
genders | Object | 性别,包括男、女、未知 |
platforms | Object | 终端类型,包括 iPhone,android,其他 |
devices | Object | 机型,如苹果 iPhone 6,OPPO R9 等 |
ages | Object | 年龄,包括17岁以下、18-24岁等区间 |
province 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
city 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
genders 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
platforms 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
devices 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
ages 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
visitUv 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
province | Object | 省份,如北京、广东等 |
city | Object | 城市,如北京、广州等 |
genders | Object | 性别,包括男、女、未知 |
platforms | Object | 终端类型,包括 iPhone,android,其他 |
devices | Object | 机型,如苹果 iPhone 6,OPPO R9 等 |
ages | Object | 年龄,包括17岁以下、18-24岁等区间 |
province 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
city 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
genders 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
platforms 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
devices 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
ages 的结构
属性 | 类型 | 说明 |
---|---|---|
id | number | 属性值id |
name | string | 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 |
accessSourceVisitUv | number | 该场景访问uv |
请求数据示例
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"
}