tencent cloud

文档反馈

多条任务统计数据聚合查询

最后更新时间:2024-01-17 14:26:44

    接口说明

    请求方式:POST。 调用频率限制:200次/小时。
    服务地址/v3/statistics/get_push_group_stat_channel
    接口服务地址与服务接入点一一对应,请选择与您的应用服务接入点对应的 服务地址
    接口功能:可根据 GroupID 或 planId 来查询最近7天内相同 GroupID 或 planId 的所有已推送任务的分推送渠道的聚合统计数据。
    说明:
    GroupID 将逐渐废弃,推荐使用 planId 查询聚合统计数据。

    参数说明

    请求参数

    参数名称
    必选
    类型
    描述
    planId
    String
    多条任务聚合统计的字段,对应推送参数中的 “plan_id”
    groupId
    String
    多条任务聚合统计的字段,对应推送参数中的 “group_Id” 注意:该参数将逐渐废弃,推荐使用 planId 查询聚合统计数据
    startDate
    String
    查询开始日期
    格式:YYYYMMDD
    限制:只能聚合统计最近7天的推送任务
    endDate
    String
    查询截止日期,格式:YYYYMMDD
    说明:
    若请求参数中同时存在 planId 和 groupId,则默认按 planId 查询。

    应答参数

    参数名称
    类型
    描述
    retCode
    Integer
    返回状态码
    errMsg
    String
    错误信息
    pushStatDataAll
    Array
    pushStatDataAll 结构变量见下表

    pushStatDataAll

    参数名称
    类型
    描述
    channel
    String
    推送通道名称
    xg:TPNS 通道
    hw:华为通道
    xm:小米通道
    mz:魅族通道
    oppo:OPPO 通道
    vivo:vivo 通道
    apns:APNs 通道
    fcm:FCM 通道
    rog:ROG 通道
    iospk: 苹果 pushkit 通道,仅国际站支持
    apns: 苹果通道
    honor:荣耀通道
    all:通道汇总
    pushState
    Object
    pushState 结构变量见下表

    pushState(Android)

    参数名称
    类型
    说明
    pushActiveUv
    Integer
    计划发送数 根据推送选定的符合目标人群筛选条件且开启了通知栏状态的90天内有联网的有效设备数。
    pushOnlineUv
    Integer
    实际发送数 在计划发送设备数中,实际已经成功下发到厂商通道的或者通过 TPNS 通道对进程在线终端下发成功的有效设备数。
    arrivalUv
    Integer
    抵达设备数(包含 TPNS 通道及厂商通道抵达回执,其中华为、魅族通道抵达回执需要手动添加配置,详情可参见 厂商通道抵达回执获取指南
    verifySvcUv
    Integer
    抵达设备数(仅 TPNS 通道、ROG 通道、FCM 通道有效。其他厂商通道由 TPNS 实际发送 pushOnlineUv 指标补齐)。 注意:此字段后续将下线,抵达数据建议参考 arrivalUv 字段。
    callbackVerifySvcUv
    Integer
    厂商通道抵达回执(华为、魅族通道抵达回执需要手动添加配置,详情可参见 厂商通道抵达回执获取指南)。 注意:此字段后续将下线,抵达数据建议参考 arrivalUv 字段。
    verifyUv
    Integer
    展示(已废弃,后续会下线此字段)
    clickUv
    Integer
    点击
    cleanupUv
    Integer
    清除
    
    说明:
    数组中“all”通道对应汇总统计数据。
    汇总数据中 verifySvcUv(抵达设备),verifyUv(展示),clickUv(点击),cleanupUv(清除)指标只汇总计算了 TPNS 通道数据、ROG 通道数据、FCM 通道数据。
    汇总数据中 pushActiveUv(计划发送), pushOnlineUv(实际发送)汇总计算了 TPNS 通道 + 厂商通道的数据。
    汇总数据中 callbackVerifySvcUv(厂商通道抵达回执)汇总计算了 厂商通道 callbackVerifySvcUv(厂商通道抵达回执)+ TPNS 通道 verifySvcUv(抵达设备)+ ROG 通道 verifySvcUv(抵达设备)+ FCM 通道 verifySvcUv(抵达设备)。

    pushState(iOS)

    参数名称
    类型
    说明
    pushActiveUv
    Integer
    计划发送
    pushOnlineUv
    Integer
    APNs 成功接收
    verifySvcUv
    Integer
    抵达
    clickUv
    Integer
    点击

    示例说明

    请求示例

    {
    "groupid": "pt:testGroup",
    "startDate": "20190912",
    "endDate": "20190912"
    }

    应答示例

    {
    "retCode": 0,
    "errMsg": "NO_ERROR",
    "pushStatDataAll": [
    {
    "channel": "fcm",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "rog",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "hw",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "xm",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "oppo",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "vivo",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "mz",
    "pushState": {
    "pushActiveUv": 0,
    "pushOnlineUv": 0,
    "verifySvcUv": 0,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 0,
    "clickUv": 0,
    "cleanupUv": 0
    }
    },
    {
    "channel": "xg",
    "pushState": {
    "pushActiveUv": 4641,
    "pushOnlineUv": 4641,
    "verifySvcUv": 4641,
    "callbackVerifySvcUv": 0,
    "arrivalUv": 0,
    "verifyUv": 4639,
    "clickUv": 3818,
    "cleanupUv": 4200
    }
    },
    {
    "channel": "all",
    "pushState": {
    "pushActiveUv": 4641,
    "pushOnlineUv": 4641,
    "verifySvcUv": 4641,
    "callbackVerifySvcUv": 4641,
    "arrivalUv": 4641,
    "verifyUv": 4639,
    "clickUv": 3818,
    "cleanupUv": 4200
    }
    }
    ]
    }