Skip to content

U-MiniProgram 小程序统计(com.umeng.umini)

通过 umeng-cli call 命令调用友盟 OpenAPI,使用 AK/SK 签名鉴权(HMAC-SHA1)。

通用调用方式

bash
umeng-cli call '{"name":"<接口名>","api":{"method":"GET","baseUrl":"https://gateway.open.umeng.com/openapi","endpoint":"param2/1/com.umeng.umini/<接口名>","authType":"umeng-aksk"}}' '<参数JSON>'

AK/SK 会在首次调用时自动通过登录凭证获取并加密缓存,无需手动配置。


接口列表


umeng.umini.h5.getElementValueList — 获取H5曝光元素的属性的统计数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
elementIdString元素id
timeUnitString时间颗粒度(枚举范围day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-09-10)
toDateString结束时间(示例: 2020-09-10)
orderByString排序指标(count,device)(示例: count)
directionString排序方向(desc:降序,asc:正序)(示例: desc)
pageIndexInteger页码(示例: 1)
pageSizeInteger每页条数(示例: 30)
bash
umeng-cli call '{"name": "umeng.umini.h5.getElementValueList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.h5.getElementValueList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "elementId": "", "timeUnit": "day", "fromDate": "2020-09-10", "toDate": "2020-09-10"}'

返回字段:

字段类型说明
datagetElementValueListDTO
msgString
codeLong
successBoolean

getElementValueListDTO 结构(获取H5曝光元素的属性的统计数据):

字段类型说明
totalCountInteger当前页
currentPageInteger总记录数
dataelementValueDTO[]

elementValueDTO[] 结构(获取H5曝光元素的属性的DTO):

字段类型说明
displayNameString元素属性值
elementValueString元素属性值备注
countLong曝光次数
deviceLong曝光人数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "displayName": "xxx",
        "count": 0,
        "elementValue": "xxx",
        "device": 0
      }
    ],
    "totalCount": 0,
    "currentPage": 0
  }
}

umeng.umini.h5.getElementList — 获取H5曝光元素统计数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
timeUnitString时间颗粒度(枚举范围day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-09-10)
toDateString结束时间(示例: 2020-09-10)
orderByString排序指标(count,device)
directionString排序方向(desc:降序,asc:正序)
pageIndexInteger页码
pageSizeInteger每页条数
bash
umeng-cli call '{"name": "umeng.umini.h5.getElementList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.h5.getElementList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "timeUnit": "day", "fromDate": "2020-09-10", "toDate": "2020-09-10"}'

返回字段:

字段类型说明
datagetElementListDTO
msgString
codeLong
successBoolean

getElementListDTO 结构(获取H5曝光元素统计数据):

字段类型说明
currentPageInteger当前页
totalCountInteger总记录数
dataelementDTO[]

elementDTO[] 结构(获取H5曝光元素的DTO):

字段类型说明
elementIdString元素ID
displayNameString元素ID备注
countLong曝光次数
deviceLong曝光人数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "elementId": "xxx",
        "displayName": "xxx",
        "count": 0,
        "device": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.h5.getSceneOverview — 获取H5场景来源统计数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
fromDateString开始时间(示例: 2020-09-10)
toDateString结束时间(示例: 2020-09-10)
timeUnitString时间颗粒度(枚举范围day,7day,30day)(示例: day)
orderByString排序指标(newUser:新增用户;activeUser:活跃用户;visitTimes:页面访问次数)
directionString排序方向(desc:降序,asc:正序)
bash
umeng-cli call '{"name": "umeng.umini.h5.getSceneOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.h5.getSceneOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "fromDate": "2020-09-10", "toDate": "2020-09-10", "timeUnit": "day"}'

返回字段:

字段类型说明
datagetSceneOverviewDTO
msgString
codeLong
successBoolean

getSceneOverviewDTO 结构(获取H5域名来源统计数据):

字段类型说明
datadomainOrSceneDTO[]
currentPageInteger当前页
totalCountInteger总记录数

domainOrSceneDTO[] 结构(获取H5域名或场景DTO):

字段类型说明
idStringid
nameString域名或场景名称
activeUserLong活跃用户
newUserLong新增用户
visitTimesLong页面访问次数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "activeUser": 0,
        "newUser": 0,
        "name": "xxx",
        "id": "xxx",
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.createCampaign — 添加推广链接

参数类型必填说明
dataSourceIdString数据源id(AppKey)
campaignNameString推广活动
channelNameString推广渠道
pathString落地页路径
bash
umeng-cli call '{"name": "umeng.umini.createCampaign", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.createCampaign", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "campaignName": "", "channelName": ""}'

返回字段:

字段类型说明
dataString
msgString
codeLong
successBoolean

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.getSceneInfoList — 获取渠道或活动信息列表

参数类型必填说明
dataSourceIdString数据源id(AppKey)
sourceTypeString场景值类型,活动campaign 渠道channel(示例: campaign)
bash
umeng-cli call '{"name": "umeng.umini.getSceneInfoList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getSceneInfoList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "sourceType": "campaign"}'

返回字段:

字段类型说明
datagetSceneInfoDTO[]数据结果
msgString
codeLong
successBoolean

getSceneInfoDTO[] 结构(获取渠道或活动信息DTO):

字段类型说明
codeString推广活动值/渠道值
nameString推广活动/渠道中文名称
urlString推广活动连接
createDateTimeString推广活动创建时间

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "code": "xxx",
      "name": "xxx",
      "url": "xxx",
      "createDateTime": "xxx"
    }
  ]
}

umeng.umini.getRetentionByDataSourceId — 获取应用的留存数据

参数类型必填说明
dataSourceIdString数据源ID(appkey)
fromDateString开始时间 yyyy-MM-dd(示例: 2021-01-19)
toDateString结束时间 yyyy-MM-dd(示例: 2021-01-01)
timeUnitString时间颗粒度 day,week(示例: day)
pageIndexInteger页码(示例: 1)
pageSizeInteger每页条数(示例: 10)
indicatorString指标:新增用户(newuser) 活跃用户 activeUser(示例: activeUser)
valueTypeString数据类型:留存率(rate) 留存数(num)(示例: rate)
bash
umeng-cli call '{"name": "umeng.umini.getRetentionByDataSourceId", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getRetentionByDataSourceId", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "fromDate": "2021-01-19", "toDate": "2021-01-01", "timeUnit": "day", "valueType": "rate"}'

返回字段:

字段类型说明
datagetRetentionByDataSourceIdListDTO返回留存数据
codeLong状态码
successBoolean状态
msgString返回消息

getRetentionByDataSourceIdListDTO 结构(应用级-留存数据列表DTO):

字段类型说明
totalCountInteger当前页码
currentPageInteger总条数
datagetRetentionByDataSourceIdDTO[]结果列表

getRetentionByDataSourceIdDTO[] 结构(获取应用级留存数据DTO):

字段类型说明
dateTimeString日期
valueLong新增/活跃用户数据
v1String次1日/周
v2String次2日/周
v3String次3日/周
v4String次4日/周
v5String次5日/周
v6String次6日/周
v7String次7日/周
v14String次14日/周
v30String次30日/周

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "v6": "xxx",
        "v7": "xxx",
        "v30": "xxx",
        "v14": "xxx",
        "v1": "xxx",
        "v2": "xxx",
        "value": 0,
        "v3": "xxx",
        "v4": "xxx",
        "v5": "xxx"
      }
    ],
    "totalCount": 0,
    "currentPage": 0
  }
}

umeng.umini.getCustomerSourceOverview — 获取获客来源的指标数据

获取-获客来源的指标数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
sourceTypeString获客来源类型(活动:campaign;H5场景:platform; 其他场景:scene;渠道:channel )
fromDateString开始时间(yyyy-MM-dd)
toDateString结束时间(yyyy-MM-dd)
timeUnitString时间颗粒度(day,7day,30day)
orderByString排序指标,默认新增用户(新增用户:newUser;打开次数:launch;活跃用户:activeUser;页面访问次数:visitTimes;次均停留时长:onceDuration;创建时间:createDateTime)
directionString排序方向,默认倒序(正序:asc;倒序:desc)
bash
umeng-cli call '{"name": "umeng.umini.getCustomerSourceOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getCustomerSourceOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "sourceType": "", "fromDate": "2025-04-01", "toDate": "2025-04-01", "timeUnit": ""}'

返回字段:

字段类型说明
datacustomerSourceDTO[]
msgString
codeLong
successBoolean

customerSourceDTO[] 结构(获客来源的指标数据DTO):

字段类型说明
idStringid
nameString名称
urlStringURL(仅推广活动可用)
onceDurationString次均停留时长(H5暂不支持)
activeUserLong活跃用户
newUserLong新增用户
launchLong打开次数(H5暂不支持)
visitTimesLong页面访问次数
createDateTimeString创建时间(仅推广活动可用)

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "onceDuration": "xxx",
      "activeUser": 0,
      "newUser": 0,
      "name": "xxx",
      "launch": 0,
      "id": "xxx",
      "url": "xxx",
      "visitTimes": 0,
      "createDateTime": "xxx"
    }
  ]
}

umeng.umini.getMultiIndiceList — 获取分组指标列表

获取分组指标列表(H5暂不支持)

参数类型必填说明
dataSourceIdString数据源id(AppKey)(示例: 1dfe1b2f3597245664499a91)
bash
umeng-cli call '{"name": "umeng.umini.getMultiIndiceList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getMultiIndiceList", "authType": "umeng-aksk"}}' '{"dataSourceId": "1dfe1b2f3597245664499a91"}'

返回字段:

字段类型说明
datamultiIndiceDTO[]
msgString
codeLong
successBoolean

multiIndiceDTO[] 结构(分组指标DTO):

字段类型说明
gmtModifiedString修改时间
indicesIdString指标ID
codeString指标类型(触发用户数:event_device,触发次数:event_count,累计值:property_num_sum)
propertyNameString属性名
displayNameString指标名
eventNameString事件名称

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "gmtModified": "xxx",
      "indicesId": "xxx",
      "code": "xxx",
      "propertyName": "xxx",
      "displayName": "xxx",
      "eventName": "xxx"
    }
  ]
}

umeng.umini.getMultiOverview — 获取分组指标数据

获取分组指标数据(H5暂不支持)

参数类型必填说明
dataSourceIdString数据源id(AppKey)(示例: 1dfe1b2f3597245664499a91)
isvString分组名称(示例: isv8)
fromDateString开始时间(示例: 2020-10-10)
toDateString结束时间(示例: 2020-10-31)
timeUnitString时间颗粒度,枚举范围day,7day,30day,week,month(逗号分隔)(默认: day)
groupNameString分组层级(仅支持最低层级)(示例: 门店)
bash
umeng-cli call '{"name": "umeng.umini.getMultiOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getMultiOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "1dfe1b2f3597245664499a91", "isv": "isv8", "fromDate": "2020-10-10", "toDate": "2020-10-31", "timeUnit": "day", "groupName": "门店"}'

返回字段:

字段类型说明
dataString
msgString
codeLong
successBoolean

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.initMultiLevelTree — 上传层级分组结构

上传层级分组结构(H5暂不支持)

参数类型必填说明
dataSourceIdString数据源id(AppKey)
treeJsonStringJSON层级分组结构(最多五级);(示例: {"head":["国家","省","城市","门店"],"rows":[["中国","北京","朝阳区","金辉大厦店"],["中国","北京","朝阳区","绿地中心店"]]})
bash
umeng-cli call '{"name": "umeng.umini.initMultiLevelTree", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.initMultiLevelTree", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "treeJson": "{\"head\":[\"国家\",\"省\",\"城市\",\"门店\"],\"rows\":[[\"中国\",\"北京\",\"朝阳区\",\"金辉大厦店\"],[\"中国\",\"北京\",\"朝阳区\",\"绿地中心店\"]]}"}'

返回字段:

字段类型说明
msgString
codeLong
successBoolean
dataString

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.getMultiLevelTree — 获取层级分组结构

获取层级分组结构(H5暂不支持)

参数类型必填说明
dataSourceIdString数据源id(AppKey)
bash
umeng-cli call '{"name": "umeng.umini.getMultiLevelTree", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getMultiLevelTree", "authType": "umeng-aksk"}}' '{"dataSourceId": ""}'

返回字段:

字段类型说明
msgString
codeLong
successBoolean
dataString

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.getLandingPageList — 获取页面分析-入口页面列表

获取页面分析-入口页面列表(H5暂不支持)

参数类型必填说明
dataSourceIdString数据源id(AppKey)
timeUnitString时间颗粒度(可选参数:day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-08-10)
toDateString结束时间(示例: 2020-08-10)
orderByStringvisitTimes,visitUser,jumpRatio(示例: visitTimes)
directionString排序方向(desc:降序,asc:正序)(示例: desc)
pageIndexInteger页码(示例: 1)
pageSizeInteger每页条数(示例: 30)
bash
umeng-cli call '{"name": "umeng.umini.getLandingPageList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getLandingPageList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "timeUnit": "day", "fromDate": "2020-08-10", "toDate": "2020-08-10"}'

返回字段:

字段类型说明
datalandingPageListDTO结果数据
msgString
codeLong
successBoolean

landingPageListDTO 结构(页面分析-入口页面列表DTO):

字段类型说明
currentPageInteger当前页码
totalCountInteger总条数
datalandingPageDTO[]结果列表

landingPageDTO[] 结构(页面分析-入口页面DTO):

字段类型说明
pageString页面URL
displayNameString页面备注
visitTimesLong入口页次数
visitUserLong入口页人数
jumpRatioString跳出率

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "displayName": "xxx",
        "page": "xxx",
        "jumpRatio": "xxx",
        "visitUser": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getShareUserList — 获取分享用户列表

参数类型必填说明
dataSourceIdString数据源id(AppKey)
timeUnitString时间颗粒度(可选参数:day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-08-10)
toDateString结束时间(示例: 2020-08-10)
orderByString排序指标(count:分享次数;reflow:分享回流量;newUser:分享新增)(默认: count)
directionString排序方向(desc:降序,asc:正序)(默认: desc)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getShareUserList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getShareUserList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "timeUnit": "day", "fromDate": "2020-08-10", "toDate": "2020-08-10"}'

返回字段:

字段类型说明
datashareUserListDTO数据返回结果
msgString
codeLong
successBoolean

shareUserListDTO 结构(分享用户数据结果列表DTO):

字段类型说明
currentPageInteger当前页码
totalCountInteger总记录数
datashareUserDTO[]

shareUserDTO[] 结构(分享用户数据结果DTO):

字段类型说明
reflowRatioDouble分享回流比
avatarUrlString头像URL
reflowLong用户回流量
nickNameString用户名
newUserLong分享新增
countLong分享回流量
userIdString用户ID

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "reflowRatio": "",
        "avatarUrl": "xxx",
        "reflow": 0,
        "nickName": "xxx",
        "newUser": 0,
        "count": 0,
        "userId": "xxx"
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getVisitPageList — 获取页面分析-受访页面列表

参数类型必填说明
dataSourceIdString数据源id(AppKey)
timeUnitString时间颗粒度(可选参数:day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-08-10)
toDateString结束时间(示例: 2020-08-10)
orderByString排序指标(可选:visitTimes:页面访问次数;visitUser:页面访问用户数;pageDuration:平均页面访问时长)(示例: visitTimes)
directionString排序方向(desc:降序,asc:正序)(示例: desc)
pageIndexInteger页码(示例: 1)
pageSizeInteger每页记录数(示例: 30)
bash
umeng-cli call '{"name": "umeng.umini.getVisitPageList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getVisitPageList", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "timeUnit": "day", "fromDate": "2020-08-10", "toDate": "2020-08-10"}'

返回字段:

字段类型说明
datavisitPageListDTO
msgString
codeLong
successBoolean

visitPageListDTO 结构(页面分析-受访页面列表DTO):

字段类型说明
currentPageInteger当前页码
datavisitPageDTO[]
totalCountInteger总条数

visitPageDTO[] 结构(获取页面分析-受访页面结果DTO):

字段类型说明
displayNameString页面备注
pageDurationString平均页面访问时长(H5暂不支持)
pageString页面URL
visitUserLong页面访问用户数
visitTimesLong页面访问次数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "displayName": "xxx",
        "pageDuration": "xxx",
        "page": "xxx",
        "visitUser": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.editPathDisplayName — 编辑页面路径显示名称

参数类型必填说明
dataSourceIdString数据源ID(AppKey)
displayNameString页面别名
pathString页面URL地址
bash
umeng-cli call '{"name": "umeng.umini.editPathDisplayName", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.editPathDisplayName", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "displayName": "", "path": ""}'

返回字段:

字段类型说明
msgString
codeLong
successBoolean
dataString

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.batchCreateEvent — 批量创建事件

参数类型必填说明
dataSourceIdString数据源id(AppKey)
eventListeventDTO[]事件列表

eventDTO[] 结构(自定义事件DTO):

字段类型说明
eventNameString事件名
displayNameString事件显示名
bash
umeng-cli call '{"name": "umeng.umini.batchCreateEvent", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.batchCreateEvent", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "eventList": ""}'

返回字段:

字段类型说明
dataString数据返回结果
msgString
codeLong
successBoolean

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.editMiniApp — 编辑小程序数据源

参数类型必填说明
dataSourceIdString数据源id(AppKey)(示例: 5e8c6dea978eea071c37c682)
platformString平台(不可编辑)(示例: mini_wechat)
nameString应用名称(示例: 应用名称)
languageString语言(CN:中文; OTHER:其他)(示例: CN)
firstLevelString一级分类(行业帮助文档:https://developer.umeng.com/docs/147615/detail/169442 )(示例: 公共交通与出行)
secondLevelString二级分类(示例: 公共交通)
descriptionString描述(示例: 描述……)
miniAppIdString微信/支付宝AppId(不可单独出现,需要和下面参数组队出现)
miniAppSecretString微信AppSecret(miniAppId和miniAppSecret必须成对出现)
miniPublicKeyString支付宝PublicKey(miniAppId、miniPublicKey和miniPrivateKey必须同时出现)
miniPrivateKeyString支付宝PrivateKey(miniAppId、miniPublicKey和miniPrivateKey必须同时出现)
integrationTypeString集成类型;单应用小程序集成:single、小程序模版类应用集成 :template(默认: single)
bash
umeng-cli call '{"name": "umeng.umini.editMiniApp", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.editMiniApp", "authType": "umeng-aksk"}}' '{"dataSourceId": "5e8c6dea978eea071c37c682"}'

返回字段:

字段类型说明
codeLong状态码
successBoolean状态
dataBoolean成功true;失败false
msgString返回消息

返回示例:

json
{
  "msg": "xxx",
  "code": 0
}

umeng.umini.getShareOverview — 获取小程序某天的分享数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
timeUnitString时间颗粒度(可选:day,7day,30day)(示例: day)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getShareOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getShareOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "fromDate": "2020-03-10", "toDate": "2020-03-31", "timeUnit": "day"}'

返回字段:

字段类型说明
datashareOverviewDTO
msgString
codeLong
successBoolean

shareOverviewDTO 结构(分享数据DTO):

字段类型说明
currentPageInteger当前页码
totalCountInteger总记录数
datashareIndicatorDTO[]

shareIndicatorDTO[] 结构(分享趋势指标DTO):

字段类型说明
dateTimeString时间
reflowRatioString回流比(H5暂不支持)
reflowLong分享回流量
newUserLong分享新增
countLong分享次数
userLong分享人数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "reflowRatio": "xxx",
        "reflow": 0,
        "newUser": 0,
        "count": 0,
        "user": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getSharePageOverview — 获取页面分享概况数据

参数类型必填说明
dataSourceIdString数据源id(AppKey)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
timeUnitString时间颗粒度(day,7day,30day)(示例: day)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
orderByString排序指标(可选count,reflow,newUser,user)(默认: user)
directionString排序方向(可选desc,asc)(默认: desc)
bash
umeng-cli call '{"name": "umeng.umini.getSharePageOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getSharePageOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "", "fromDate": "2020-03-10", "toDate": "2020-03-31", "timeUnit": "day"}'

返回字段:

字段类型说明
datasharePageOverviewDTO
msgString
codeLong
successBoolean

sharePageOverviewDTO 结构(分享页面概况DTO):

字段类型说明
currentPageInteger当前页码
totalCountInteger总记录数
datasharePageIndicatorDTO[]

sharePageIndicatorDTO[] 结构(页面分享指标DTO):

字段类型说明
reflowRatioDouble分享回流比(H5暂不支持)
pathString页面url
reflowLong分享回流
newUserLong分享新增
countLong分享次数
userLong分享人数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "reflowRatio": "",
        "path": "xxx",
        "reflow": 0,
        "newUser": 0,
        "count": 0,
        "user": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getAllPropertyValueCount — 获取某事件属性下全部属性值数据

参数类型必填说明
timeUnitString时间颗粒度(可选day)(默认: day)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
propertyNameString属性名
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
eventNameString事件名
dataSourceIdString数据源id(AppKey)
bash
umeng-cli call '{"name": "umeng.umini.getAllPropertyValueCount", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getAllPropertyValueCount", "authType": "umeng-aksk"}}' '{"timeUnit": "day", "fromDate": "2020-03-10", "toDate": "2020-03-31", "propertyName": "", "eventName": "", "dataSourceId": ""}'

返回字段:

字段类型说明
dataallPropertyValueCountDTO
msgString
codeLong
successBoolean

allPropertyValueCountDTO 结构(某事件属性下全部属性值数据):

字段类型说明
currentPageInteger
totalCountInteger
datapropertyValueCountDTO[]

propertyValueCountDTO[] 结构(属性值的触发次数):

字段类型说明
countLong
propertyValueString
countRatioDouble

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "countRatio": "",
        "count": 0,
        "propertyValue": "xxx"
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getEventOverview — 获取某自定义事件统计数据

参数类型必填说明
timeUnitString时间颗粒度(默认: day)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
eventNameString事件名
dataSourceIdString数据源id(AppKey)
bash
umeng-cli call '{"name": "umeng.umini.getEventOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getEventOverview", "authType": "umeng-aksk"}}' '{"timeUnit": "day", "fromDate": "2020-03-10", "toDate": "2020-03-31", "eventName": "", "dataSourceId": ""}'

返回字段:

字段类型说明
dataeventOverviewDTO
msgString
codeLong
successBoolean

eventOverviewDTO 结构(自定义事件统计数据DTO):

字段类型说明
totalCountInteger总记录数
currentPageInteger当前页
dataeventIndicatorDTO[]

eventIndicatorDTO[] 结构(事件指标数据DTO):

字段类型说明
dateTimeString时间
countLong触发次数
deviceLong触发用户数

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "count": 0,
        "device": 0
      }
    ],
    "totalCount": 0,
    "currentPage": 0
  }
}

umeng.umini.getEventProvertyList — 获取某自定义事件的属性列表

参数类型必填说明
eventNameString事件
dataSourceIdString数据源id(AppKey)
bash
umeng-cli call '{"name": "umeng.umini.getEventProvertyList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getEventProvertyList", "authType": "umeng-aksk"}}' '{"eventName": "", "dataSourceId": ""}'

返回字段:

字段类型说明
dataeventProvertyDTO[]
msgString
codeLong
successBoolean

eventProvertyDTO[] 结构(自定义事件属性DTO):

字段类型说明
propertyNameString

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "propertyName": "xxx"
    }
  ]
}

umeng.umini.getEventList — 获取自定义事件列表

参数类型必填说明
dataSourceIdString数据源Id(AppKey)
bash
umeng-cli call '{"name": "umeng.umini.getEventList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getEventList", "authType": "umeng-aksk"}}' '{"dataSourceId": ""}'

返回字段:

字段类型说明
dataeventDTO[]
msgString
codeLong
successBoolean

eventDTO[] 结构(自定义事件DTO):

字段类型说明
eventNameString事件名
displayNameString事件显示名

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "displayName": "xxx",
      "eventName": "xxx"
    }
  ]
}

umeng.umini.getChannelOverview — 获取某推广渠道的统计数据

参数类型必填说明
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
channelString渠道
timeUnitString时间颗粒度(可选时间颗粒度:5min,hour,day,7day,30day)(默认: day)
dataSourceIdString数据源id(AppKey)
indicatorsString多个指标时,以逗号分隔(newUser,activeUser,launch,visitTimes,onceDuration)(示例: activeUser)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getChannelOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getChannelOverview", "authType": "umeng-aksk"}}' '{"fromDate": "2020-03-10", "toDate": "2020-03-31", "channel": "", "timeUnit": "day", "dataSourceId": "", "indicators": "activeUser"}'

返回字段:

字段类型说明
datarefererOverviewDTO
msgString
codeLong
successBoolean

refererOverviewDTO 结构(获取场景渠道活动等来源指标数据DTO):

字段类型说明
currentPageInteger当前页
totalCountInteger总记录数
datarefererIndicatorDTO[]

refererIndicatorDTO[] 结构(推广来源指标信息DTO):

字段类型说明
dateTimeString时间
newUserLong新增用户
activeUserLong活跃用户
launchLong打开次数(H5暂不支持)
visitTimesLong页面访问次数
onceDurationString次均停留时长(H5暂不支持)

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "activeUser": 0,
        "onceDuration": "xxx",
        "newUser": 0,
        "launch": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getCampaignOverview — 获取某推广活动的统计数据

参数类型必填说明
timeUnitString时间颗粒度(枚举范围5min,hour,day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
campaignString活动
pageSizeInteger每页记录条数(默认: 1)(示例: 30)
pageIndexInteger页码(默认: 30)(示例: 1)
dataSourceIdString数据源id(AppKey)
indicatorsString指标名称(以逗号分隔,可选择一个或多个),newUser,activeUser,launch,visitTimes,onceDuration(示例: newUser)
bash
umeng-cli call '{"name": "umeng.umini.getCampaignOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getCampaignOverview", "authType": "umeng-aksk"}}' '{"timeUnit": "day", "fromDate": "2020-03-10", "toDate": "2020-03-31", "campaign": "", "dataSourceId": "", "indicators": "newUser"}'

返回字段:

字段类型说明
datarefererOverviewDTO
msgString
codeLong
successBoolean

refererOverviewDTO 结构(获取场景渠道活动等来源指标数据DTO):

字段类型说明
currentPageInteger当前页
totalCountInteger总记录数
datarefererIndicatorDTO[]

refererIndicatorDTO[] 结构(推广来源指标信息DTO):

字段类型说明
dateTimeString时间
newUserLong新增用户
activeUserLong活跃用户
launchLong打开次数(H5暂不支持)
visitTimesLong页面访问次数
onceDurationString次均停留时长(H5暂不支持)

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "activeUser": 0,
        "onceDuration": "xxx",
        "newUser": 0,
        "launch": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getSceneOverview — 获取某场景值的统计数据

获取某场景值的统计数据(H5暂不支持)

参数类型必填说明
timeUnitString时间颗粒度(可选参数:5min,hour,day,7day,30day)(示例: day)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
sceneString场景值( 帮助文档:https://developer.umeng.com/docs/147615/detail/175369 )(示例: alipay_1090)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
dataSourceIdString数据源id(AppKey)
indicatorsString指标值(默认: activeUser)(示例: 多个指标时,以逗号分隔(newUser,activeUser,launch,visitTimes,onceDuration))
bash
umeng-cli call '{"name": "umeng.umini.getSceneOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getSceneOverview", "authType": "umeng-aksk"}}' '{"timeUnit": "day", "fromDate": "2020-03-10", "toDate": "2020-03-31", "scene": "alipay_1090", "dataSourceId": "", "indicators": "多个指标时,以逗号分隔(newUser,activeUser,launch,visitTimes,onceDuration)"}'

返回字段:

字段类型说明
datarefererOverviewDTO
msgString
codeLong
successBoolean

refererOverviewDTO 结构(获取场景渠道活动等来源指标数据DTO):

字段类型说明
currentPageInteger当前页
totalCountInteger总记录数
datarefererIndicatorDTO[]

refererIndicatorDTO[] 结构(推广来源指标信息DTO):

字段类型说明
dateTimeString
newUserLong
activeUserLong
launchLong
visitTimesLong
onceDurationString

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "activeUser": 0,
        "onceDuration": "xxx",
        "newUser": 0,
        "launch": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getAppList — 获取用户的小程序列表及数量

参数类型必填说明
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getAppList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getAppList", "authType": "umeng-aksk"}}' '{}'

返回字段:

字段类型说明
dataappListDTO
msgString
codeLong
successBoolean

appListDTO 结构(小程序列表DTO):

字段类型说明
totalCountInteger总条数
currentPageInteger当前页
dataappInfoDTO[]app信息

appInfoDTO[] 结构(应用详细信息DTO):

字段类型说明
secondLevelString二级分类
dataSourceIdString数据源id
appNameString数据源名称
gmtCreateString创建时间
firstLevelString一级分类
userNameString用户名
platformString小程序平台

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "secondLevel": "xxx",
        "dataSourceId": "xxx",
        "appName": "xxx",
        "gmtCreate": "xxx",
        "firstLevel": "xxx",
        "userName": "xxx",
        "platform": "xxx"
      }
    ],
    "totalCount": 0,
    "currentPage": 0
  }
}

umeng.umini.createMiniApp — 新建小程序数据源

参数类型必填说明
nameString名称(示例: 应用名称)
typeString类型(小程序:mini,小游戏:mini_game;H5: html_5)(默认: mini)
platformString平台( 支付宝小程序:mini_alipay;微信小程序:mini_wechat;天猫精灵:mini_tmall_genie;微信小游戏:mini_game_wechat;字节跳动小程序:mini_bytedance;百度小程序:mini_baidu;QQ小程序:mini_qq;H5: html_5 )(示例: mini_wechat)
languageString语言(CN:中文; OTHER:其他)(示例: CN)
firstLevelString一级分类(行业帮助文档:https://developer.umeng.com/docs/147615/detail/169442 )(示例: 公共交通与出行)
secondLevelString二级分类(示例: 公共交通)
descriptionString描述(示例: 描述……)
miniAppIdString微信/支付宝AppId(不可单独出现,需要和下面参数组队出现)
miniAppSecretString微信AppSecret(miniAppId和miniAppSecret必须成对出现)
miniPublicKeyString支付宝PublicKey(miniAppId、miniPublicKey和miniPrivateKey必须同时出现)
miniPrivateKeyString支付宝PrivateKey(miniAppId、miniPublicKey和miniPrivateKey必须同时出现)
integrationTypeString集成类型;单应用小程序集成:single、小程序模版类应用集成 :template(默认: single)
bash
umeng-cli call '{"name": "umeng.umini.createMiniApp", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.createMiniApp", "authType": "umeng-aksk"}}' '{"name": "应用名称", "type": "mini", "platform": "mini_wechat", "language": "CN", "firstLevel": "公共交通与出行", "secondLevel": "公共交通"}'

返回字段:

字段类型说明
codelong状态码
successboolean状态
datastring成功时返回新建小程序key
msgstring返回消息

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": "xxx"
}

umeng.umini.getOverview — 获取应用概况数据

获取应用概况数据:启动、活跃、新增、访次、次均停留时长、人均停留时长

参数类型必填说明
dataSourceIdString数据源id(AppKey)(示例: 1dfe1b2f3597245664499a9c)
fromDateString开始时间(示例: 2020-03-10)
toDateString结束时间(示例: 2020-03-31)
timeUnitString时间颗粒度,枚举范围5min,hour,day,7day,30day(示例: day)
indicatorsString指标名称(以逗号分隔,可选择一个或多个),newUser,activeUser,launch,visitTimes,onceDuration,dailyDuration(示例: newUser)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录条数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getOverview", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getOverview", "authType": "umeng-aksk"}}' '{"dataSourceId": "1dfe1b2f3597245664499a9c", "fromDate": "2020-03-10", "toDate": "2020-03-31", "timeUnit": "day", "indicators": "newUser"}'

返回字段:

字段类型说明
dataoverviewDTO
msgString
codeLong
successBoolean

overviewDTO 结构(获取小程序应用概况数据DTO):

字段类型说明
currentPageInteger当前页码
totalCountInteger总条数
dataappIndicatorDTO[]

appIndicatorDTO[] 结构(应用指标DTO):

字段类型说明
dateTimeString时间
newUserLong新增用户
activeUserLong活跃用户
launchLong打开次数(H5暂不支持)
visitTimesLong页面访问次数
onceDurationString次均停留时长(H5暂不支持)
dailyDurationString人均停留时长(H5暂不支持)

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": {
    "data": [
      {
        "dateTime": "xxx",
        "dailyDuration": "xxx",
        "activeUser": 0,
        "onceDuration": "xxx",
        "newUser": 0,
        "launch": 0,
        "visitTimes": 0
      }
    ],
    "currentPage": 0,
    "totalCount": 0
  }
}

umeng.umini.getTotalUser — 获取应用的累计用户数

参数类型必填说明
dataSourceIdString数据源id(AppKey)(示例: 5dfe1b2f3597245664499a9c)
fromDateString开始时间(示例: 2020-03-01)
toDateString结束时间(示例: 2020-03-01)
pageIndexInteger页码(默认: 1)
pageSizeInteger每页记录条数(默认: 30)
bash
umeng-cli call '{"name": "umeng.umini.getTotalUser", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.umini/umeng.umini.getTotalUser", "authType": "umeng-aksk"}}' '{"dataSourceId": "5dfe1b2f3597245664499a9c", "fromDate": "2020-03-01", "toDate": "2020-03-01"}'

返回字段:

字段类型说明
datatotalUserDTO[]
codelong状态码
msgString消息
successBoolean执行状态

totalUserDTO[] 结构(获取小程序应用累计用户数DTO):

字段类型说明
dateTimeString
totalUserLong

返回示例:

json
{
  "msg": "xxx",
  "code": 0,
  "data": [
    {
      "dateTime": "xxx",
      "totalUser": 0
    }
  ]
}

Released under the MIT License.