QueryPushStatByApp-阿里云帮助中心

Query push statistics for an app.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mpush:QueryPushStatByApp

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppKey	integer	Yes	The AppKey value.	23267207
StartTime	string	Yes	The start time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.	2016-07-25T00:00:00Z
EndTime	string	Yes	The end time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.	2016-07-29T00:00:00Z
Granularity	string	Yes	The data granularity of the response. You can only query data for up to 31 days at daily granularity. Valid values: DAY: Query data at daily granularity.	DAY

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC
AppPushStats	object
AppPushStat	array<object>	An array of AppPushStat objects. The API returns data based on the specified time granularity.
	object
Time	string	The timestamp.	2016-07-25T00:00:00Z
DeletedCount	integer	The number of notifications cleared on devices.	10
OpenedCount	integer	The number of notifications clicked on devices.	30
SmsReceiveSuccessCount	integer	The number of text messages successfully received in composite SMS push notifications. This value can be empty.	0
SmsSkipCount	integer	The number of text messages skipped in composite SMS push notifications. For example, this occurs when no phone number is bound to the device. This value can be empty.	0
SmsReceiveFailedCount	integer	The number of text messages sent but not received on mobile phones in composite SMS push notifications. This value can be empty.	0
SmsFailedCount	integer	The number of text messages that failed to send in composite SMS push notifications. Failures may occur due to service unavailability, authorization failure, or invalid parameters. This value can be empty.	0
ReceivedCount	integer	The number of notifications actually delivered to devices.	60
SentCount	integer	The number of notifications actually sent from the push server.	100
SmsSentCount	integer	The number of text messages sent in composite SMS push notifications. This value can be empty.	0
AcceptCount	integer	The number of push notifications accepted by the push server.	120

Examples

Success response

JSON format

{
  "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  "AppPushStats": {
    "AppPushStat": [
      {
        "Time": "2016-07-25T00:00:00Z",
        "DeletedCount": 10,
        "OpenedCount": 30,
        "SmsReceiveSuccessCount": 0,
        "SmsSkipCount": 0,
        "SmsReceiveFailedCount": 0,
        "SmsFailedCount": 0,
        "ReceivedCount": 60,
        "SentCount": 100,
        "SmsSentCount": 0,
        "AcceptCount": 120
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.