GetAppPvUv--应用性能监控全链路版-火山引擎

文档中心

导航

GetAppPvUv

最近更新时间：2024.09.11 14:33:07首次发布时间：2023.03.13 16:59:23

获取App的PV和UV的数值。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=GetAppPvUv&Version=2022-10-12

ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAppPvUv`	接口名称。当前 API 的名称为 `GetAppPvUv`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数	类型	是否必选	示例值	描述
start_time	Integer	是	`1665417600`	开始时间。
end_time	Integer	是	`1665504000`	终止时间。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
time_type	String	否	`-`	时间类型。 api_time：上报时间（默认） event_time：发生时间

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类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	Object of QueryMetricResponseData	`-`	返回数据。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

QueryMetricResponseData

参数	类型	示例值	描述
pv	Integer	`96708`	PV值。
uv	Integer	`2047`	UV值。

请求示例

POST https://open.volcengineapi.com?Action=GetAppPvUv&Version=2022-10-12
{
    "start_time":1677772800,
    "end_time":1678442865,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "Android"
                ]
            }
        ]
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "pv":96708,
        "uv":2047
    },
    "error_msg":"",
    "error_no":0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

QueryMetricResponseData

请求示例

返回示例

错误码