查询统计数据
查询消息推送统计数据,包括总推送条数、推送成功数、推送到达数、消息打开数、消息忽略数等。
请求参数
参数名称 | 类型 | 是否必填 | 示例 | 描述 |
appId | String | 是 | ONEX570DA89211721 | mPaaS App ID |
workspaceId | String | 是 | test | mPaaS 工作空间 |
startTime | long | 是 | 1619798400000 | 要查询的时间范围的开始时间戳,以毫秒为单位,精确到天。 |
endTime | long | 是 | 1624358433000 | 要查询的时间范围的结束时间戳,以毫秒为单位,精确到天。开始时间和结束时间间隔不能超过 90 天。 |
platform | String | 否 | ANDROID | 平台,不传则表示查询全部。可选值:IOS,ANDROID,HARMONYOS |
channel | String | 否 | ANDROID | 推送通道,不传表示查询全部。可选值:IOS、FCM、HMS、MIUI、OPPO、VIVO、ANDROID(自建通道)、HARMONYOS |
type | String | 否 | SIMPLE | 推送类型,不传表示查询全部。可选值:SIMPLE、TEMPLATE、MULTIPLE、BROADCAST |
taskId | String | 否 | 20842863 | 推送任务 ID |
返回参数
参数名称 | 类型 | 示例 | 描述 |
RequestId | String | B589F4F4-CD68-3CE5-BDA0-6597F33E23916512 | 请求 ID |
ResultCode | String | OK | 请求结果码 |
ResultMessage | String | param is invalid | 请求错误描述 |
ResultContent | JSON | - | 响应内容 |
data | JSON | - | 响应内容。该参数值包含在 |
pushTotalNum | float | 100 | 推送数 |
pushNum | float | 100 | 推送成功数 |
arrivalNum | float | 100 | 推送到达数 |
openNum | float | 100 | 推送打开数 |
openRate | float | 100 | 推送打开率 |
ignoreNum | float | 100 | 推送忽略数 |
ignoreRate | float | 100 | 推送忽略率 |
使用示例
DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
// 创建 DefaultAcsClient 实例并初始化
// 阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维,请登录 RAM 控制台创建 RAM 用户
// 此处以把 AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里
// 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里,会存在密钥泄漏风险
// 建议先完成环境变量配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
DefaultProfile profile = DefaultProfile.getProfile(
"cn-hangzhou", // 地域 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();
}
查询推送任务列表
查询通过控制台创建或通过调用 API 触发的批量推送任务和群发推送任务信息。
请求参数
参数名称 | 类型 | 是否必填 | 描述 | 描述 |
appId | String | 是 | ONEX570DA89211721 | mPaaS App ID |
workspaceId | String | 是 | test | mPaaS 工作空间 |
startTime | long | 是 | 1619798400000 | 开始时间戳,以毫秒为单位,精确到天。 |
taskId | String | 否 | 20842863 | 推送任务 ID |
taskName | String | 否 | 测试任务 | 推送任务名称 |
pageNumber | int | 否 | 1 | 页码,默认为 1。 |
pageSize | int | 否 | 10 | 页数,默认为 500。 |
返回参数
参数名称 | 类型 | 示例 | 描述 |
RequestId | String | B589F4F4-CD68-3CE5-BDA0-6597F33E23916512 | 请求 ID |
ResultCode | String | OK | 请求结果码 |
ResultMessage | String | param is invalid | 请求错误描述 |
ResultContent | JSON | 响应内容 | |
data | JSONArray | 响应内容。该参数值包含在 | |
taskId | String | 20927873 | 任务 ID |
taskName | String | 测试任务 | 任务名称 |
templateId | String | 9108 | 模板 ID |
templateName | String | 测试模板 | 模板名称 |
type | long | 3 | 推送类型,其中:
|
gmtCreate | long | 1630052750000 | 创建时间 |
使用示例
DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
// 创建 DefaultAcsClient 实例并初始化
// 阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维,请登录 RAM 控制台创建 RAM 用户
// 此处以把 AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里
// 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里,会存在密钥泄漏风险
// 建议先完成环境变量配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
DefaultProfile profile = DefaultProfile.getProfile(
"cn-hangzhou", // 地域 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("测试任务");
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();
}
查询推送任务详情
查询通过控制台创建或通过调用 API 触发的批量推送任务和群发推送任务的任务详情。
请求参数
参数名称 | 类型 | 是否必填 | 示例 | 描述 |
appId | String | 是 | ONEX570DA89211721 | mPaaS App ID |
workspaceId | String | 是 | test | mPaaS 工作空间 |
taskId | String | 是 | 20842863 | 推送任务 ID |
返回参数
参数名称 | 类型 | 示例 | 描述 |
RequestId | String | B589F4F4-CD68-3CE5-BDA0-6597F33E23916512 | 请求 ID |
ResultCode | String | OK | 请求结果码 |
ResultMessage | String | param is invalid | 请求错误描述 |
ResultContent | JSON | 响应内容 | |
data | JSON | 响应内容。该参数值包含在 | |
taskId | long | 20927872 | 任务 ID |
pushNum | float | 10 | 推送数 |
pushSuccessNum | float | 10 | 推送成功数 |
pushArrivalNum | float | 10 | 推送到达数 |
startTime | long | 1630052735000 | 开始时间(毫秒) |
endTime | long | 1630052831000 | 结束时间(毫秒) |
duration | string | 00 小时 01 分 36 秒 | 持续时间 |
使用示例
DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
// 创建 DefaultAcsClient 实例并初始化
// 阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维,请登录 RAM 控制台创建 RAM 用户
// 此处以把 AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里
// 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里,会存在密钥泄漏风险
// 建议先完成环境变量配置
String accessKeyId = System.getenv("MPAAS_AK_ENV");
String accessKeySecret = System.getenv("MPAAS_SK_ENV");
DefaultProfile profile = DefaultProfile.getProfile(
"cn-hangzhou", // 地域 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();
}