Querying Aggregated Statistics for Multiple Tasks

Last updated: 2020-11-06 11:31:51

    API Description

    Request method: POST.
    Calling frequency limit: 200 times/hour.

    request address/v3/statistics/get_push_group_stat_channel

    The API request address is corresponding to the service access point. Select the request address corresponding to the service access point of your application.

    Feature: this API is used to query the aggregated statistics by push channel of all push tasks *with the same GroupID or planId * in the last 7 days according to GroupID or planId.

    Parameter Description

    Request parameters

    Parameter Name Required Type Description
    planId Yes String Field for aggregated statistics of multiple tasks, using corresponding "planId" in push parameters
    groupId Yes String Field for aggregated statistics of multiple tasks, using corresponding "group_Id" in push parameters. This field will be disused gradually
    startDate Yes String Query start date
  • Format: YYYYMMDD
  • Limit: only data of push tasks in the last 7 days can be aggregated
  • endDate Yes String Query end date. Format: YYYYMMDD

    Note:

    If both planId and groupId exist in the request parameter, the query will be based on planId by default.

    Response parameters

    Parameter Name Type Description
    retCode Integer Returned status code
    errMsg String Error message
    pushStatDataAll Array Returned result: individual element formed by channel and pushState, where channel is the channel name. pushState structure variables are shown in following table

    pushState (Android)

    Parameter Name Type Description
    pushActiveUv Integer Attempted
    The number of available devices online in the last 90 days with the notification bar enabled in the push target devices.
    pushOnlineUv Integer Sent
    The number of available devices to which the message was successfully delivered through the vendor or TPNS channel out of the attempted devices.
    arrivalUv Integer Number of reached devices (including arrival receipts for the TPNS and vendor channels. For the Huawei and Meizu channels, you need to add a configuration item for arrival receipt manually. For more information, please see Acquisition of Vendor Channel Arrival Receipt)
    verifySvcUv Integer Number of reached devices (only valid for TPNS, ROG, and FCM channels. For other vendor channels, the pushOnlineUv metric of actual deliveries by TPNS will be used). Note: this field will be disused subsequently. You are recommended to check the arrivalUv field for arrival data
    callbackVerifySvcUv Integer Arrival receipt for vendor channel (for the Huawei and Meizu channels, you need to add a configuration item for arrival receipt manually. For more information, please see Acquisition of Vendor Channel Arrival Receipt). Note: this field will be disused subsequently. You are recommended to check the arrivalUv field for arrival data
    verifyUv Integer Displayed (this field has been disused and will be deactivated subsequently)
    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 aggregates the data of the TPNS, ROG, and FCM channels.
    • In the aggregated statistics, pushActiveUv (attempted) and pushOnlineUv (sent) aggregates 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 (device reached).

    pushState (iOS)

    Parameter Name Type Description
    pushActiveUv Integer Attempted
    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
                }
            }
        ]
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help