You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/App端/事件/AnalyseRank
AnalyseRank
最近更新时间：2024.07.15 16:31:27首次发布时间：2022.10.14 11:52:07
我的收藏

查看事件列表。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=AnalyseRank&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是AnalyseRank接口名称。当前 API 的名称为 AnalyseRank。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
start_timeInteger是1630473600开始时间。
end_timeInteger是1630560000结束时间。
filtersObject of Condition是-筛选条件，可以指定多个键值对来筛选数据。
event_nameString否example_event事件名称。

order_by

String

是

count

排序方式。

  • count：事件上报量。
  • per_capita：事件人均上报。
  • user：事件用户数。
keywordString是example_keyword关键词。

os

String

是

Android

操作系统。

  • Android
  • iOS
page_noInteger是1页码。
page_sizeInteger是20每页大小。

Condition

参数类型是否必选示例值描述

op

String

否

in

操作符。

  • gt：大于
  • gte：大于等于
  • lt：小于
  • lte：小于等于
  • eq：等于
  • neq：不等于
  • in：包含
  • not_in：不包含
  • lk：模糊匹配特定模式的数据
  • nlk：排除模糊匹配的数据

type

String

否

expression

筛选条件类型。

  • expression：当前condition是一个表达式。
  • and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。
  • or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。
  • map：当前condition是map类型。
valueString否Android筛选值。
valuesArray of String否["Android"]筛选值，支持多个。
map_keyString否key_1map类型key，当type为map时必填。
dimensionString否aid条件的名称。
sub_conditionsArray of Condition否-子条件。

返回参数

参数类型示例值描述
dataObject of RankData-事件列表数据。
error_msgStringsuccess错误消息。
error_noInteger500错误码。0为成功。

RankData

参数类型示例值描述
itemsArray of RankItem排行项列表
totalInteger100事件总数。

RankItem

参数类型示例值描述
nameStringevent事件名称。

type

String

metric

事件类型。

  • metric：指标
  • dimension：维度
labelStringexample_label指标或维度标签。

请求示例

POST https://open.volcengineapi.com?Action=AnalyseRank&Version=2022-10-12
{
    "start_time": 1658664000,
    "end_time": 1658750543,
    "keyword":"",
    "OS":"iOS",
    "page_no": 1,
    "page_size": 10,
    "filters": {
        "type": "and",
        "sub_conditions": [
            {
                "dimension": "os",
                "op": "in",
                "type": "expression",
                "values": [
                    "iOS"
                ]
            }
        ]
    },
    "order_by": "count"
}

返回示例

{
    "data": {
        "items": [
            {
                "name": "event",
                "label": "example_label",
                "type": "metric"
            }
        ],
        "total": 1
    },
    "error_msg": "",
    "error_no": 0
}

错误码

本接口无特有的错误码。更多信息请参见错误码。