이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

All/Tagged Users Push Data Statistics

Feature Description
After turning on the Push service, call this API to query Push stats for all users/tags.
API Call Description
Sample Request URL
https://xxxxxx/v4/timpush/all_member_push_statistics?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification and their descriptions when calling this API. For more details about the parameters, refer to REST API introduction.
Parameter
Description
xxxxxx
The dedicated domain name corresponding to the country/region where the SDKAppID resides.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/all_member_push_statistics
Request API
sdkappid
The SDKAppID assigned by the IM console when creating an application
identifier
Must be an App administrator account. For more details, see app admin.
usersig
The App administrator account's generated signature. For details, see generate UserSig.
random
Please enter a random 32-bit unsigned integer in the range of [0, 4294967295]
contenttype
The request format is fixed as json.
Maximum Calling Frequency
1 time/second.
Sample Request Packet
{
    "StartTime":1741104000,
    "EndTime":1741795200,
    "TaskID":["xxx-yyy-zzz","aaa-bbb-ccc"]
}
﻿
Request Packet Fields
Field
Type
Attribute
Description
StartTime
Integer
Required
The start unix timestamp for querying, in seconds, supports up to 30 days of data query.
EndTime
Integer
Required
The start unix timestamp for querying, in seconds, supports up to 30 days of data query.
TaskID
Array
Required
Supports simultaneous query of multiple task IDs, up to 5. Leave blank for overall statistics.
Sample Response Packet
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "sucess",
    "Results": [
        {
            "TaskID": "xxx-yyy-zzz",
            "TotalCount": 2670,
            "SentCount": 2213,
            "DeliveredCount": 532,
            "ClickCount": 206,
            "PlatformStatistics": [
                {
                    "EventType":1,
                    "PushPlatform": 1,
                    "TotalCount": 532,
                    "SentCount": 391,
                    "DeliveredCount": 0,
                    "ClickCount": 27
                }
            ]
        },
        {
            "TaskID": "aaa-bbb-ccc",
            "TotalCount": 2941,
            "SentCount": 2430,
            "DeliveredCount": 546,
            "ClickCount": 300,
            "PlatformStatistics": [
                {
                    "EventType":1,
                    "PushPlatform": 2,
                    "TotalCount": 266,
                    "SentCount": 236,
                    "DeliveredCount": 162,
                    "ClickCount": 24
                }
            ]
        }
    ]
}
Response Packet Fields
Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code. 0 indicates success, non-0 indicates failure.
ErrorInfo
String
Error message.
Results
Array
The statistical result corresponding to TaskID.
TaskID
String
Push task identifier. If empty, it means overall statistics.
TotalCount
Integer
Quantity that can be sent.
SentCount
Integer
Number of messages sent.
DeliveredCount
Integer
Number of reaches.
ClickCount
Integer
Number of clicks.
PlatformStatistics
Array
Statistical result for each push channel.
EventType
Integer
1=offline push; 2=online push.
PushPlatform
Integer
Push vendor (online push EventType = 2 is case-insensitive, default return 0):
PushPlatform = 0 means unknown vendor
PushPlatform = 1 means Apple APNS push
PushPlatform = 2 means Mi Push
PushPlatform = 3 means Huawei Push
PushPlatform = 4 means Google FCM push
PushPlatform = 5 means Meizu Push
PushPlatform = 6 means OPPO push
PushPlatform = 7 means vivo push
PushPlatform = 8 means HONOR Push
Error Code Description
Unless a network error occurs (for example, 502 error), the HTTP return code of this API is 200. The actual error code and error information are indicated by ResultCode, ResultInfo, ErrorCode, and ErrorInfo in the response payload.
Common error codes (60000 to 79999), please refer to Error Code.
Private error codes of this API are as follows:
Error Code
Description
91000
Request error. According to the error prompt, troubleshoot the problem.
90009
Request lacks permissions. Use the administrator to call.
90045
The service is not enabled. Ensure the service is turned on.
90100
Invalid request parameters. According to the documentation, verify the validity of the parameters.
90102
Internal error, please retry later.
90103
Failed to switch accounts. Please check if the UserID is valid.
﻿
﻿

Parameter	Description
xxxxxx	The dedicated domain name corresponding to the country/region where the SDKAppID resides. China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` Seoul: `adminapikr.im.qcloud.com` Frankfurt: `adminapiger.im.qcloud.com` Silicon Valley: `adminapiusa.im.qcloud.com` Jakarta: `adminapiidn.im.qcloud.com`
v4/timpush/all_member_push_statistics	Request API
sdkappid	The SDKAppID assigned by the IM console when creating an application
identifier	Must be an App administrator account. For more details, see app admin.
usersig	The App administrator account's generated signature. For details, see generate UserSig.
random	Please enter a random 32-bit unsigned integer in the range of [0, 4294967295]
contenttype	The request format is fixed as `json`.

Field	Type	Attribute	Description
StartTime	Integer	Required	The start unix timestamp for querying, in seconds, supports up to 30 days of data query.
EndTime	Integer	Required	The start unix timestamp for querying, in seconds, supports up to 30 days of data query.
TaskID	Array	Required	Supports simultaneous query of multiple task IDs, up to 5. Leave blank for overall statistics.

Error Code	Description
91000	Request error. According to the error prompt, troubleshoot the problem.
90009	Request lacks permissions. Use the administrator to call.
90045	The service is not enabled. Ensure the service is turned on.
90100	Invalid request parameters. According to the documentation, verify the validity of the parameters.
90102	Internal error, please retry later.
90103	Failed to switch accounts. Please check if the UserID is valid.