Skip to content

AppTrack 移动广告监测(com.umeng.apptrack)

通过 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.apptrack/<接口名>","authType":"umeng-aksk"}}' '<参数JSON>'

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


接口列表


umeng.apptrack.backReportData — 合作渠道报表数据回传

为众盟定制开发的投放报表数据回传接口

参数类型必填说明
reportListreport[]报表数据信息

report[] 结构(报表字段定义):

字段类型说明
orderIdstring本次投放订单号
advertiserIdlong广告主id
adPlanIdlong推广计划id
adPlanNamestring推广计划名称
adGroupIdlong推广组id
adGroupNamestring推广组名称
adCreativeIdlong推广创意id
adCreativeNamestring推广创意名称
pidlong推广位id
pidNamestring推广位名称
mediaIdlong媒体id
mediaNamestring媒体名称
landingUrlstring落地页链接
showPvlong展现pv
clickPvlong点击pv
bidCostdouble竞价消耗
conversionUvlong转化数
dsstring数据日期
retentionCountlong次日留存数
versioninteger数据版本号
bash
umeng-cli call '{"name": "umeng.apptrack.backReportData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.backReportData", "authType": "umeng-aksk"}}' '{"reportList": ""}'

返回字段:

字段类型说明
resultboolean

返回示例:

json
{}

umeng.apptrack.getActiveDetailData — 获得用户app激活数据信息明细【pro】

此接口限定pro用户使用,根据用户输入appKey和计划id,queryDate,返回激活设备明细数据

参数类型必填说明
appKeystring应用appkey
planIdlong计划id(示例: 从用户计划列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
pageNuminteger当前页数(示例: 1)
pageSizeinteger每页显示的记录数(示例: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getActiveDetailData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getActiveDetailData", "authType": "umeng-aksk"}}' '{"appKey": "", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
dataAppDownload[]激活数据明细
totalinteger总数

AppDownload[] 结构(激活明细信息下载):

字段类型说明
unitIdlong监测单元id
mNamestring监测单元名称
planNamestring推广计划名称
chanNamestring渠道名称
typestring激活类型:
iOS:IDFA、CAID、IDFV等
Android:IMEI、OAID、ANDROID_ID等
deviceIdstring激活设备id,其中IDFA、IMEI基于原值做md5加密,其他为原值
clickDatestring点击日期:20200116
activeDatestring激活日期:20200116

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "chanName": "xxx",
      "activeDate": "xxx",
      "unitId": 0,
      "planName": "xxx",
      "mName": "xxx",
      "type": "xxx",
      "deviceId": "xxx",
      "clickDate": "xxx"
    }
  ]
}

umeng.apptrack.getPayAnalysisData — 获得付费订单数据

根据计划id或单元id查询出该计划id或单元id下用户拍下订单数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(默认: 0)(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
pageNuminteger当前页数(默认: 1)
pageSizeinteger每页显示的记录数(默认: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getPayAnalysisData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getPayAnalysisData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
dataGetPayAnalysis[]
totalinteger总数

GetPayAnalysis[] 结构(获得拍下付费数据):

字段类型说明
payIdstring付费(拍下)ID
payItemstring付费(拍下)商品
orderIdstring订单号
amountBigDecimal付费(拍下)金额
activateDsstring激活日期
eventDsstring事件日期
clickDsstring点击日期

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "amount": "",
      "orderId": "xxx",
      "payItem": "xxx",
      "activateDs": "xxx",
      "payId": "xxx",
      "eventDs": "xxx",
      "clickDs": "xxx"
    }
  ]
}

umeng.apptrack.getOrderAnalysisData — 获得拍下订单数据

根据计划id或单元id查询出该计划id或单元id下用户拍下订单数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(默认: 0)(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
pageNuminteger当前页数(默认: 1)
pageSizeinteger每页显示的记录数(默认: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getOrderAnalysisData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getOrderAnalysisData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
dataGetPayAnalysis[]
totalinteger总数

GetPayAnalysis[] 结构(获得拍下付费数据):

字段类型说明
payIdstring付费(拍下)ID
payItemstring付费(拍下)商品
orderIdstring订单号
amountBigDecimal付费(拍下)金额
activateDsstring激活日期
eventDsstring事件日期
clickDsstring点击日期

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "amount": "",
      "orderId": "xxx",
      "payItem": "xxx",
      "activateDs": "xxx",
      "payId": "xxx",
      "eventDs": "xxx",
      "clickDs": "xxx"
    }
  ]
}

umeng.apptrack.getRegisterAnalysisData — 获得注册事件分析数据

根据计划id或单元id查询出该计划id或单元id下用户注册事件数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(默认: 0)(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
pageNuminteger当前页数(默认: 1)
pageSizeinteger每页显示的记录数(默认: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getRegisterAnalysisData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getRegisterAnalysisData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
dataGetRegisterAnalysis[]注册事件列表
totalinteger总数

GetRegisterAnalysis[] 结构(注册事件分析):

字段类型说明
registerIdstring注册id
eventDsstring注册日期
activateDsstring激活日期
clickDsstring点击日期

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "registerId": "xxx",
      "activateDs": "xxx",
      "eventDs": "xxx",
      "clickDs": "xxx"
    }
  ]
}

umeng.apptrack.getMonitoringList — 获得监测单元列表

根据用户输入的计划id返回该计划id下的监测单元id

参数类型必填说明
planIdinteger推广计划id(默认: 0)(示例: 从用户计划列表接口获取)
pageNuminteger当前页数(默认: 1)
pageSizeinteger每页显示的记录数(默认: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getMonitoringList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getMonitoringList", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取"}'

返回字段:

字段类型说明
dataAppMonitors[]
totalinteger总记录数

AppMonitors[] 结构(推广计划下的单元信息):

字段类型说明
midlong单元id
mNamestring单元名称
chanNamestring渠道名称
downloadUrlstring下载地址
shortUrlstring短链地址

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "shortUrl": "xxx",
      "chanName": "xxx",
      "downloadUrl": "xxx",
      "mid": 0,
      "mName": "xxx"
    }
  ]
}

umeng.apptrack.getPlanList — 获得用户计划列表

根据用户id获得用户计划列表

参数类型必填说明
appKeystring应用appKey
pageNuminteger当前页数(默认: 1)
pageSizeinteger每页显示的记录数(默认: 10)
bash
umeng-cli call '{"name": "umeng.apptrack.getPlanList", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getPlanList", "authType": "umeng-aksk"}}' '{}'

返回字段:

字段类型说明
dataAppRecPlan[]
totalinteger总记录数

AppRecPlan[] 结构(计划信息):

字段类型说明
planIdinteger计划Id
planNamestring计划名称
startDaystring计划开始日期
endDaystring计划结束日期

返回示例:

json
{
  "total": 0,
  "data": [
    {
      "startDay": "xxx",
      "endDay": "xxx",
      "planName": "xxx",
      "planId": 0
    }
  ]
}

umeng.apptrack.getMyEventData — 获取用户自定义事件

根据用户输入的计划id或者监测单元id返回用户自定义事件数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(默认: null)(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
bash
umeng-cli call '{"name": "umeng.apptrack.getMyEventData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getMyEventData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
dataAppEvent[]

AppEvent[] 结构(获取用户自定义事件):

字段类型说明
eventNamestring自定义事件名称
eventNumberlong自定义事件值

返回示例:

json
{
  "data": [
    {
      "eventNumber": 0,
      "eventName": "xxx"
    }
  ]
}

umeng.apptrack.getClickActiveData — 获得点击激活数据

根据计划id或单元id查询出该计划id或单元id下的点击激活数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
bash
umeng-cli call '{"name": "umeng.apptrack.getClickActiveData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getClickActiveData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
clickPvlong点击pv
clickUvlong点击uv
activateUvlong激活真人数
activateRateBigDecimal点击激活比率
totalActivateUvlong总激活
activateDevicelong点击激活

返回示例:

json
{
  "clickUv": 0,
  "clickPv": 0,
  "totalActivateUv": 0,
  "activateUv": 0,
  "activateDevice": 0
}

umeng.apptrack.getRegisterLoginData — 获得计划注册登录相关数据

根据计划id或单元id查询出该计划id或单元id下的注册登录等相关数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
bash
umeng-cli call '{"name": "umeng.apptrack.getRegisterLoginData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getRegisterLoginData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
registerlong注册数量
loginlong登录数量
roleDevicelong创建角色数量
orderDevicelong拍下订单设备数量
orderAmountBigDecimal拍下订单金额
payDevicelong付费设备数
amountBigDecimal付费金额

返回示例:

json
{
  "orderDevice": 0,
  "roleDevice": 0,
  "payDevice": 0,
  "login": 0,
  "register": 0
}

umeng.apptrack.getStayTrendData — 获取留存数据

根据用户输入计划id和单元id获取留存数据

参数类型必填说明
planIdlong计划id(示例: 从用户计划列表接口获取)
unitIdlong单元id(默认: null)(示例: 从监测单元列表接口获取)
queryDatestring查询日期(示例: 2018-12-19)
bash
umeng-cli call '{"name": "umeng.apptrack.getStayTrendData", "api": {"method": "GET", "baseUrl": "https://gateway.open.umeng.com/openapi", "endpoint": "param2/1/com.umeng.apptrack/umeng.apptrack.getStayTrendData", "authType": "umeng-aksk"}}' '{"planId": "从用户计划列表接口获取", "queryDate": "2018-12-19"}'

返回字段:

字段类型说明
stay1long次日留存数据
stay2long第3日留存数据
stay3long第4日留存数据
stay4long第5日留存数据
stay5long第6日留存数据
stay6long第7日留存数据
stay7long第8日留存数据
stay8long第9日留存数据
stay9long第10日留存数据
stay10long第11日留存数据
stay11long第12日留存数据
stay12long第13日留存数据
stay13long第14日留存数据
stay14long第15日留存数据

返回示例:

json
{
  "stay9": 0,
  "stay3": 0,
  "stay4": 0,
  "stay14": 0,
  "stay1": 0,
  "stay2": 0,
  "stay7": 0,
  "stay11": 0,
  "stay8": 0,
  "stay10": 0,
  "stay5": 0,
  "stay13": 0,
  "stay6": 0,
  "stay12": 0
}

Released under the MIT License.