Usage analysis - Mobile Platform as a Service - Alibaba Cloud Documentation Center

Query statistical data

Query message push statistics, including total pushes, successful pushes, arrivals, message opens, and message ignores.

Request parameters

Parameter name	Type	Required	Example	Description
appId	String	Yes	ONEX570DA89211721	mPaaS App ID
workspaceId	String	Yes	test	mPaaS workspace
startTime	long	Yes	1619798400000	The start timestamp of the time range to query, in milliseconds, accurate to the day.
endTime	long	Yes	1624358433000	The end timestamp of the time range to query, in milliseconds, accurate to the day. The interval between the start time and end time cannot exceed 90 days.
platform	String	No	ANDROID	The platform. If not specified, all platforms are queried. Optional values: IOS, ANDROID
channel	String	No	ANDROID	The push channel. If not specified, all channels are queried. Optional values: IOS, FCM, HMS, MIUI, OPPO, VIVO, ANDROID (self-built channel)
type	String	No	SIMPLE	The push type. If not specified, all types are queried. Optional values: SIMPLE, TEMPLATE, MULTIPLE, BROADCAST
taskId	String	No	20842863	Push task ID

Response parameters

Parameter name	Type	Example	Description
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	Request ID
ResultCode	String	OK	Request result code
ResultMessage	String	param is invalid	Request error description
ResultContent	JSON	-	Response content
data	JSON	-	The response content. This parameter value is included in the `ResultContent` JSON string.
pushTotalNum	float	100	Push count
pushNum	float	100	Successful push count
arrivalNum	float	100	Arrival count
openNum	float	100	Open count
openRate	float	100	Open rate
ignoreNum	float	100	Ignore count
ignoreRate	float	100	Ignore rate

Usage example

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // Create a DefaultAcsClient instance and initialize
        // The Alibaba Cloud account AccessKey has access privileges for all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or routine maintenance. Log on to the RAM console to create a RAM user
        // This example shows how to save the AccessKey and AccessKeySecret in environment variables. You can also save them in the configuration file based on your business requirements
        // We strongly recommend that you do not specify the AccessKey ID or AccessKey secret in code because the AccessKey pair may be leaked
        // It is recommended to complete the environment variable configuration first
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // Region ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisCoreIndexRequest request = new QueryPushAnalysisCoreIndexRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setEndTime(Long.valueOf("1624982400000"));
        request.setPlatform("ANDROID");
        request.setChannel("ANDROID");
        request.setType("SIMPLE");
        request.setTaskId("20842863");

        QueryPushAnalysisCoreIndexResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Query push task list

Query batch and mass push tasks created through the console or triggered by API calls.

Request parameters

Parameter name	Type	Required	Description	Description
appId	String	Yes	ONEX570DA89211721	mPaaS App ID
workspaceId	String	Yes	test	mPaaS workspace
startTime	long	Yes	1619798400000	Start timestamp, in milliseconds, accurate to the day.
taskId	String	No	20842863	Push task ID
taskName	String	No	Test task	Push task name
pageNumber	int	No	1	The page number. Default value: 1.
pageSize	int	No	10	The number of pages. Default value: 500.

Response parameters

Parameter name	Type	Example	Description
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	Request ID
ResultCode	String	OK	Request result code
ResultMessage	String	param is invalid	Request error description
ResultContent	JSON		Response content
data	JSONArray		The response content. This parameter value is included in the `ResultContent` JSON string.
taskId	String	20927873	Task ID
taskName	String	Test task	Task name
templateId	String	9108	Template ID
templateName	String	Test template	Template name
type	long	3	Push type, where: 2 - Batch push 3 - Mass push
gmtCreate	long	1630052750000	Creation time

Usage example

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // Create a DefaultAcsClient instance and initialize
        // The Alibaba Cloud account AccessKey has access privileges for all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or routine maintenance. Log on to the RAM console to create a RAM user
        // This example shows how to save the AccessKey and AccessKeySecret in environment variables. You can also save them in the configuration file based on your business requirements
        // We strongly recommend that you do not specify the AccessKey ID or AccessKey secret in code because the AccessKey pair may be leaked
        // It is recommended to complete the environment variable configuration first
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // Region ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskListRequest request = new QueryPushAnalysisTaskListRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("default");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setTaskId("20845212");
        request.setTaskName("Test task");
        request.setPageNumber(1);
        request.setPageSize(10);

        QueryPushAnalysisTaskListResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Query push task details

Query details of batch and mass push tasks created through the console or triggered by API calls.

Request parameters

Parameter name	Type	Required	Example	Description
appId	String	Yes	ONEX570DA89211721	mPaaS App ID
workspaceId	String	Yes	test	mPaaS workspace
taskId	String	Yes	20842863	Push task ID

Response parameters

Parameter name	Type	Example	Description
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	Request ID
ResultCode	String	OK	Request result code
ResultMessage	String	param is invalid	Request error description
ResultContent	JSON		Response content
data	JSON		The response content. This parameter value is included in the `ResultContent` JSON string.
taskId	long	20927872	Task ID
pushNum	float	10	Push count
pushSuccessNum	float	10	Successful push count
pushArrivalNum	float	10	Arrival count
startTime	long	1630052735000	Start time (milliseconds)
endTime	long	1630052831000	End time (milliseconds)
duration	string	00 hours 01 min 36 sec	Duration

Usage example

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // Create a DefaultAcsClient instance and initialize
        // The Alibaba Cloud account AccessKey has access privileges for all APIs, which is highly risky. We strongly recommend that you create and use a RAM user for API access or routine maintenance. Log on to the RAM console to create a RAM user
        // This example shows how to save the AccessKey and AccessKeySecret in environment variables. You can also save them in the configuration file based on your business requirements
        // We strongly recommend that you do not specify the AccessKey ID or AccessKey secret in code because the AccessKey pair may be leaked
        // It is recommended to complete the environment variable configuration first
        String accessKeyId = System.getenv("MPAAS_AK_ENV");
        String accessKeySecret = System.getenv("MPAAS_SK_ENV");
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // Region ID
            accessKeyId,      
            accessKeySecret); 

        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskDetailRequest request = new QueryPushAnalysisTaskDetailRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setTaskId("20845212");

        QueryPushAnalysisTaskDetailResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }