You need to enable JavaScript to run this app.
导航
DataList
最近更新时间:2023.12.26 18:54:56首次发布时间:2022.11.18 15:32:34

调用DataList接口获取具体类型的上报详情列表。

使用说明

  • 接口名称:DataList
  • 请求方式:POST
  • 接口地址:/?Action=DataList&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

DataList

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

filter_conditions

object of filter_conditions

-

筛选条件。

page_num

i32

1

页号。

page_size

i32

10

每页项数。

ev_type

string

session

上报类型。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

filter_conditions

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of children

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

children

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of string

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数

类型

示例值

描述

data

object of data

-

指定类型的上报详情list。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

table_list

array of table_list

-

具体页号的上报详情list,按客户端时间倒序返回。

table_list

参数

类型

示例值

描述

ev_type

string

session

上报类型。

metric_map

object of metric_map

{"browser_brand":{"value":"Chrome","label":"browser_brand","groupKey":"","groupName":""},"fcp":{"value":"1109.6","label":"首次有内容渲染时间(FCP)","unit":"ms","groupKey":"","groupName":""}

具体上报详情。

json

string

-

原始上报json。

请求示例

POST https://open.volcengineapi.com/?Action=DataList&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "filter_conditions": {
        "type": "and",
        "values": "[数据探索]",
        "field": "pid",
        "op": "in",
        "children": [
            {
                "type": "and",
                "field": "pid",
                "children": [],
                "op": "in",
                "groupKey": "context",
                "values": "[数据探索]"
            }
        ],
        "groupKey": "context"
    },
    "page_num": 1,
    "page_size": 10,
    "ev_type": "session"
}

返回示例

正常返回示例

{
    "data": {
        "table_list": [
            {
                "ev_type": "session",
                "json": "bored",
                "metric_map": "{\"browser_brand\":{\"value\":\"Chrome\",\"label\":\"browser_brand\",\"groupKey\":\"\",\"groupName\":\"\"},\"fcp\":{\"value\":\"1109.6\",\"label\":\"首次有内容渲染时间(FCP)\",\"unit\":\"ms\",\"groupKey\":\"\",\"groupName\":\"\"}"
            }
        ]
    },
    "error_no": 0,
    "error_msg": ""
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2018****22D30",
        "Action": "DataList",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}