Querying Aggregated Statistics for Multiple Tasks

Recent Pages

Querying Aggregated Statistics for Multiple Tasks

Last updated: 2024-01-17 14:26:44

API Description
Request method: POST
Calling frequency limit: 200 times/hour
Service URL/v3/statistics/get_push_group_stat_channel
API service URLs correspond to service access points one by one. Please select the service URL corresponding to the service access point of your application.
Feature: This API is used to query the aggregated statistics (by channel) of all push tasks that have the same GroupID or planId in last 7 days.
Note: 
GroupID will be discarded gradually. Therefore, you are advised to use planId to query the aggregated statistics.
Parameters
Request parameters
Parameter
Required
Type
Description
planId
Yes
String
Parameter for aggregated statistics of multiple tasks, corresponding to planId in the push parameters
groupId
Yes
String
Parameter for aggregated statistics of multiple tasks, corresponding to group_Id in the push parameters
Note: This parameter will be discarded gradually. Therefore, you are advised to use planId to query the aggregated statistics.
startDate
Yes
String
Query start date
Format: YYYYMMDD
Limit: only data of push tasks in last 7 days can be aggregated.
endDate
Yes
String
Query end date. Format: YYYYMMDD
Note: 
If both planId and groupId are specified, the query will be based on planId by default.
Response parameters
Parameter
Type
Description
retCode
Integer
Returned status code
errMsg
String
Error message
pushStatDataAll
Array
Variables in the pushStatDataAll structure. See the table below for details.
pushStatDataAll
Parameter
Type
Description
channel
String
Name of a push channel
xg: TPNS
hw: Huawei
xm: Mi
mz: Meizu
oppo: OPPO
vivo: vivo
apns: APNs
fcm: FCM
rog: ROG
iospk: Apple PushKit channel (available only in International Site)
apns: Apple channel
honor: Honor channel
all: all channels
pushState
Object
Variables in the pushState structure. See the table below for details.
pushState (Android)
Parameter
Type
Description
pushActiveUv
Integer
Scheduled delivery count
Number of available devices online in last 90 days with the notification bar enabled in the push target devices
pushOnlineUv
Integer
Actual delivery count
Number of available devices to which the message was successfully delivered through the vendor or TPNS channel out of the devices for scheduled delivery
arrivalUv
Integer
Number of reached devices (including arrival receipts for the TPNS and vendor channels. For Huawei and Meizu channels, you need to configure the arrival receipt manually. For more information, please see Acquisition of Vendor Channel Arrival Receipt)
verifySvcUv
Integer
Number of reached devices (only for TPNS, ROG, and FCM channels. The arrival data of other vendor channels is displayed using the pushOnlineUv parameter of TPNS). 
Note: This parameter will be discontinued later. Therefore, you are advised to use arrivalUv for the arrival data.
callbackVerifySvcUv
Integer
Arrival receipt for vendor channels (for the Huawei and Meizu channels, you need to configure the arrival receipt manually. For more information, please see Acquisition of Vendor Channel Arrival Receipt). 
Note: This parameter will be discontinued later. Therefore, you are advised to use arrivalUv for the arrival data.
verifyUv
Integer
Displayed (this parameter has been discarded and will be discontinued later)
clickUv
Integer
Clicked
cleanupUv
Integer
Cleared
Note: 
The "all" channel in the array corresponds to the aggregated statistics.
In the aggregated statistics, the verifySvcUv (reached devices), verifyUv (displayed), clickUv (clicked), and cleanupUv (cleared) metrics only aggregate the data of the TPNS, ROG, and FCM channels.
In the aggregated statistics, pushActiveUv (scheduled delivery) and pushOnlineUv (actual delivery) aggregate the data of the TPNS channel and vendor channels.
In the aggregated statistics, callbackVerifySvcUv (arrival receipt of vendor channel) aggregates the data of vendor channel's callbackVerifySvcUv (arrival receipt of vendor channel) + TPNS channel's verifySvcUv (reached devices) + ROG channel's verifySvcUv (reached devices) + FCM channel's verifySvcUv (reached devices).
pushState (iOS)
Parameter
Type
Description
pushActiveUv
Integer
Scheduled delivery
pushOnlineUv
Integer
Successfully received by APNs
verifySvcUv
Integer
Reached
clickUv
Integer
Clicked
Samples
Sample request
{
    "groupid": "pt:testGroup",
    "startDate": "20190912",
    "endDate": "20190912"
}
Sample response
{
    "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
            }
        }
    ]
}
﻿

tencent cloud

Recent Pages

Querying Aggregated Statistics for Multiple Tasks

API Description

Parameters

Request parameters

Response parameters

pushStatDataAll

pushState (Android)

pushState (iOS)

Samples

Sample request

Sample response

Was this page helpful?

Was this page helpful?

Parameter	Required	Type	Description
planId	Yes	String	Parameter for aggregated statistics of multiple tasks, corresponding to `planId` in the push parameters
groupId	Yes	String	Parameter for aggregated statistics of multiple tasks, corresponding to `group_Id` in the push parameters Note: This parameter will be discarded gradually. Therefore, you are advised to use `planId` to query the aggregated statistics.
startDate	Yes	String	Query start date Format: YYYYMMDD Limit: only data of push tasks in last 7 days can be aggregated.
endDate	Yes	String	Query end date. Format: YYYYMMDD

tencent cloud

Sign Up

Log in

Recent Pages

Querying Aggregated Statistics for Multiple Tasks

API Description

Parameters

Request parameters

Response parameters

pushStatDataAll

pushState (Android)

pushState (iOS)

Samples

Sample request

Sample response

Was this page helpful?

Was this page helpful?