QueryDeviceStat

更新时间:
复制 MD 格式

Queries device statistics by application dimension.

Operation description

Note

Currently, this API supports only daily data. The daily dimension lets you query data for up to 31 days. Days are calculated based on UTC+8.

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:QueryDeviceStat

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AppKey

integer

Yes

AppKey information.

23267207

StartTime

string

Yes

The start time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ.

Note

The statistics start date is 00:00 UTC+8 on the start time's day.

2016-07-28T00:00:00Z

EndTime

string

Yes

The end time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ.

Note

The statistics end date is the end time's day.

2016-07-29T00:00:00Z

DeviceType

string

No

Important This parameter is only valid for early Android and iOS dual-platform application types. If your application is a dual-platform application, specify this parameter as iOS or ANDROID to query the number of devices for each type. By default, it queries ALL types.

The device type. Valid values:

  • iOS: iOS devices

  • ANDROID: Android devices

  • ALL: All device types

Valid values:

  • ALL :

    ALL

  • ANDROID :

    ANDROID

  • iOS :

    iOS

iOS

QueryType

string

Yes

Query new devices or historical cumulative devices. Valid values:

  • NEW: New devices

  • TOTAL: Cumulative devices

TOTAL

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC

AppDeviceStats

object

AppDeviceStat

array<object>

An array of device statistics, AppDeviceStat.

object

The AppDeviceStat object for device statistics.

Time

string

The end time. Use ISO 8601 format in UTC, such as YYYY-MM-DDThh:mm:ssZ.

2016-07-28T16:00:00Z

DeviceType

string

Device type.

iOS

Count

integer

Number of devices.

100

Examples

Success response

JSON format

{
  "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  "AppDeviceStats": {
    "AppDeviceStat": [
      {
        "Time": "2016-07-28T16:00:00Z",
        "DeviceType": "iOS",
        "Count": 100
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.