You need to enable JavaScript to run this app.
导航
GetTrendPerAction
最近更新时间:2024.07.12 17:21:37首次发布时间:2022.11.01 11:26:00

获取指定Action的数量趋势。

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
action_typeStringclikAction类型。调用GetActionOverviewList接口查看取值。
pidString数据探索页面ID。调用GetActionOverviewList接口查看取值。
action_target_nameString描述Action名字。调用GetActionOverviewList接口查看取值。
commonObject of CommonParams-通用参数。
time_filterObject of TimeFilter-时间区间。
filter_conditionsObject of FilterCondition-筛选条件。
metric_typeStringavg耗时指标统计方式。支持avg(默认)、pct50pct75pct90pct95

CommonParams

参数类型是否必选示例值描述
aidLong12345应用ID。
site_typeStringweb站点类型。
envStringonline环境,填""时为全部。
osStringwebpro服务类型,可选值为webproappminipro
userStringtest_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger1665485413起始时间,单位s。
end_timeInteger1665744613终止时间,单位s。
granularityInteger3600聚合时间粒度,单位s。

FilterCondition

参数类型是否必选示例值描述
typeStringand筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。
fieldStringpid条件字段key,可选值集合由GetFieldKeys方法获取。
opStringin条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。
groupKeyStringcontextmap类型字段key,可选值集合由GetFieldKeys方法获取。
valuesArray of String[数据探索]条件值,可选值集合由GetFieldValues方法获取。
childrenArray of FilterCondition-如果下层还有条件,则放入该处,即type为and时必填。这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数类型示例值描述
dataObject of OverviewTrendResponseData-返回内容。
error_noInteger0错误码,成功为0。
error_msgString""错误信息,成功为空。

OverviewTrendResponseData

参数类型示例值描述
infoArray of OverviewTrendInfoItem-自定义事件总览值。
chartObject of ChartData-自定义事件上报趋势。
extraObject of TrendExtra-自定义事件额外信息。

OverviewTrendInfoItem

参数类型示例值描述
idStringcount汇总值key。
nameString白屏数汇总值名。
unitStringms汇总值单位。
countString1汇总值。
changeString1.0环比。

ChartData

参数类型示例值描述
fieldsArray of Field-折线图/饼图维度,len(fields)=len(source[i])。
sourceArray of String[["1668355200","js_error","0","0"]]趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

TrendExtra

参数类型示例值描述
release_infoArray of ReleaseInfo-版本发布情况。

Field

参数类型示例值描述
idStringdate维度key。
nameString日期维度名。
dataTypeStringstring维度类型。
aggregateString-聚合方式。

ReleaseInfo

参数类型示例值描述
envStringtest版本发布环境。
commitString[]版本相关commit。
releaseStringv2.2.123版本。
create_atInteger1668483578版本发布时间。

请求示例

POST https://open.volcengineapi.com/?Action=GetTrendPerAction&Version=2022-10-12
{
    "common":{
        "aid":12345
    },
    "time_filter":{
        "start_time":1664621845,
        "end_time":1665140253,
        "granularity":86400
    },
    "action_type":"click",
    "pid":"数据探索",
    "action_target_name":"描述",
    "metric_type":"avg",
    "filter_conditions":{
        "type":"and",
        "children":[
            {
                "op":"in",
                "field":"pid",
                "values":[
                    "数据探索"
                ]
            }
        ]
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "chart":{
            "fields":[
                {
                    "id":"date",
                    "dataType":"string",
                    "name":""
                },
                {
                    "id":"count",
                    "dataType":"number",
                    "name":"Action 触发数"
                }
            ],
            "source":[
                [
                    "1665072000",
                    "4"
                ]
            ]
        },
        "info":[
            {
                "id":"count",
                "name":"Action 触发数",
                "count":"14",
                "change":"-0.2632"
            }
        ],
        "extra":{
            "release_info":[

            ]
        }
    },
    "error_msg":"",
    "error_no":0
}

错误码

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