更新时间：2023.04.10 16:07:02
调用AnalyseSummary接口查看事件概览。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
os | string | 是 |
| 操作系统。
|
start_time | int32 | 是 |
| 开始时间。 |
end_time | int32 | 是 |
| 结束时间。 |
compare_start_time | int32 | 是 |
| 比较开始时间。 |
compare_end_time | int32 | 是 |
| 比较结束时间。 |
filters | object of filters | 是 | - | 筛选条件。 |
order_by | string | 是 |
| 排序条件。 |
event_name | string | 否 |
| 事件名称。 |
attribute_type | string | 否 |
| 属性类型。
|
attribute_name | string | 否 |
| 属性名称。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
type | string | 是 |
| 筛选条件操作类型。 |
sub_conditions | object of sub_conditions | 是 | - | 子筛选条件。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
dimension | string | 否 |
| 筛选维度。 |
op | string | 否 |
| 子筛选条件操作。
|
type | string | 否 |
| 子筛选条件操作类型。
|
values | array | 否 |
| 筛选值。 |
参数 | 类型 | 示例值 | 说明 |
|---|---|---|---|
err_detail | string | - | 错误详情。 |
data | object of data | - | 返回的业务数据。各个接口返回不同，部分接口无此字段。 |
error_msg | string | - | 错误信息。 |
error_no | int |
| 错误码。0为成功。 |
参数 | 类型 | 示例值 | 说明 |
|---|---|---|---|
count | object of count | - | 事件上报量。 |
per_capita | object of per_capita | - | 事件人均上报。 |
user | object of user | - | 事件用户数。 |
参数 | 类型 | 示例值 | 说明 |
|---|---|---|---|
current | int32 |
| 当前上报量。 |
compare | int32 |
| 环比上报量。 |
rate | int32 |
| 上报量变化率。 |
参数 | 类型 | 示例值 | 说明 |
|---|---|---|---|
current | int32 |
| 当前人均上报。 |
compare | int32 |
| 环比人均上报。 |
rate | int32 |
| 人均上报变化率。 |
参数 | 类型 | 示例值 | 说明 |
|---|---|---|---|
current | int32 |
| 当前用户数。 |
compare | int32 |
| 环比用户数。 |
rate | int32 |
| 用户数变化率。 |
POST https://open.volcengineapi.com/?Action=AnalyseSummary&Version=2022-10-12 { "os":"iOS", "start_time":1658664000, "end_time":1658750543, "compare_start_time":1658577457, "compare_end_time":1658664000, "filters":{ "type":"and", "sub_conditions":[ { "dimension":"os", "op":"in", "type":"expression", "values":[ "iOS" ] } ] }, "order_by":"count" }
{ "err_detail": "", "data": { "count": { "current": 870, "compare": 0, "rate": 0 }, "per_capita": { "current": 145, "compare": 0, "rate": 0 }, "user": { "current": 6, "compare": 0, "rate": 0 } }, "error_msg": "", "error_no": 0 }