Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

String

是

1

项目ID

ApiAction

String

是

getAllMetricList

固定值，对应“请求说明”中的“接口名称”

ApiVersion

String

是

2024-05-22

固定值，版本号： 2024-05-22

subjectId

Int

否

1

主体ID，参考附录-主体ID获取方式

filterColumns

Array

否

[]

过滤条件

sortBy

String

否

updateTime

排序字段

order

String

否

Desc

排序方式：Asc、Desc

platform

String

否

cdp

平台

pageSize

Int

否

10

每页大小

current

Int

否

1

页码

permissionValue

String

否

read_role

权限模型：admin、read_role、write_role、download_role、access、write_role_periodic、write_role_manual、unknown

effectAnalysisSource

String

否

xxx

效果分析数据源过滤，支持为空，如果传入值，则会过滤非传入效果分析数据源的预置指标

selfCreate

Bool

否

false

过滤出我创建的

shared

Bool

否

false

过滤出授权给我的

bookmark

Bool

否

false

只查看收藏的

empty

Boolean

否

false

是否可为空

value

Object

否

男

值

values

Array

否

[男]

值列表

column

String

否

gender

列

msg

String

成功

接口返回信息

code

Number

0

状态码，0表示正常

data

PageRespAnalysisModuleObjResp

接口返回数据体

traceId

String

跟踪id

total

Int

100

总数

pageSize

Int

10

每页大小

current

Int

1

当前页

pageNum

Int

1

当前页

items

Array

[]

记录

id

Number

1

指标id

seg

JsonNode

{}

分群条件

name

String

名称

指标名称

descr

String

描述

指标描述

active

Boolean

true

是否开启

period

BasePeriod

{}

时间

message

String

succeed

描述说明

metrics

BaseMetrics

{}

指标

panelId

Number

1

panelId，可能为空

updater

String

admin

最近更新人

bookmark

Boolean

true

是否收藏

editAble

Boolean

true

是否可编辑

platform

String

CDP

数据来源平台

dimension

BaseDimension

{}

维度

subjectId

Int

1

主体ID

authFilter

Boolean

true

是否使用行权限

authSchema

JsonNode

{}

行权限DSL

cdpModules

Array

[]

模块

createTime

String

2020-01-01 10:00:00

创建时间

deleteAble

Boolean

false

是否可删除

domainType

String

Private

公私域类型：Private、Public

periodShow

String

7天

归因窗口

updateTime

String

2022-01-01 10:00:00

最近更新时间

domainInfos

Array

[]

分组id

segRequired

Boolean

true

是否需要传入人群条件

analysisType

String

ATTRIBUTION

计算类型：
USER_TENDENCY、TRANS、ATTRIBUTION、ATTRIBUTION_COLUMN、NORMAL、NORMAL_COLUMN、CROSS_DIMENSION、NORMAL_COLUMN_LINKAGE、NORMAL_COUNT、CROSS_DIMENSION_MERGE、EXTRA

scheduleTime

String

2022-01-01 10:00:00

定时任务最近修改时间

displayConfig

JsonNode

{}

前端展示配置

scheduleRange

String

DAILY

调度范围：MANUAL、DAILY、WEEKLY、MONTHLY

periodRequired

Boolean

true

是否需要传入时间周期

metricsRequired

Boolean

true

是否需要传入指标条件

usableCdpModules

Array

[segAnalysis]

可使用的cdp模块

dimensionRequired

Boolean

true

是否需要传入维度条件

analysisModuleObjId

Number

1

分析模块id

attributionModelType

String

末次触点归因

归因方式

analysisModuleObjName

String

测试指标

指标名称

analysisModuleObjCreator

String

admin

创建人

num

Int

1

时间单位量

name

String

天

事件单位名称

type

String

RANGE

类型：
DATE
RANGE
ZONE

offset

Int

2

日期偏移

endTime

String

2020-01-01 10:00:00

结束时间

baseTime

String

2020-01-01 00:00:00

基准时间

startTime

String

2020-01-01 08:00:00

开始时间

periodRange

Sring

DAY

时间单位：
YEAR
MONTH
WEEK
DAY
HOUR
MINUTE

name

String

指标

指标名称

limit

Int

1

指标数量限制

method

String

SUM

指标计算模型：
SUM,AVG,MAX,MIN,COUNT,DISTINCT_COUNT,COUNT_WITH_ATTR,DISTINCT_COUNT_WITH_ATTR,ATTRIBUTION,TRANS,FUNCTION,SINGLE,ID,MULTI_METRICS,USER_TENDENCY

period

BasePeriod

{}

时间

function

FunctionObj

{}

函数

metricsId

Int

1

指标ID

formatEnum

String

INTEGER

展示方式：
INTEGER、FLOAT、PERCENT_INTEGER、PERCENT_FLOAT

metricsList

Array

[]

多指标对象

simpleFormat

Boolean

false

简单格式化

metricsCnName

String

指标

指标中文名称，只用于模版，用户名称和id的替换

attributionObj

AnalysisAttributionObj

{}

分析对象

targetIdTypeId

Int

1

计算输出的id类型

attributionType

String

FIRST

归因分析模型：
FIRST、LAST、LINE、POSITION、ATTENUATION、FULL

attributionEvent

Array

[]

属性事件

analysisAttributionObjs

Array

[]

分析对象

nodes

Array

{}

节点

function

String

方法

方法

attr

Array

[]

分析属性

name

String

名称

维度统一名称，用于行为圈选时展示

type

String

TAG

维度信息类型：
TAG、EVENT、DETAIL、SEG、SEG_RULE、DATE、PROPERTY

index

Int

1

id

limit

Int

10

维度数量限制，按照维度数量进行降序

nodes

Array

[]

子节点

tagId

Int

2

标签id，type=TAG时有效

attrId

Int

3

预定义维度id，type=ATTR时有效

endObj

PathObj

{}

结束节点

method

String

SUM

计算方式：
SUM、AVG、MAX、MIN、COUNT、DISTINCT_COUNT、COUNT_WITH_ATTR、DISTINCT_COUNT_WITH_ATTR、ATTRIBUTION、TRANS、FUNCTION、SINGLE、ID、MULTI_METRICS、USER_TENDENCY

segIds

Array

[1,2]

人群id，只有type为SEG时有效

values

Array

[小学,初中]

用户指定维度

breakUp

Boolean

false

是否打散，只用于行为

eventId

Int

3

行为id，只有type为EVENT时有效

exclude

JosnNode

{}

排除选项

include

JsonNode

{}

包含选项

columnId

Int

4

字段列id，只有type为DETAIL时有效

distinct

Boolean

false

是否去重

segRules

Array

[]

人群规则，只有type为SEG_RULE时有效

startObj

PathObj

{}

开始节点

condition

EventAttributionObjCondition

{}

条件

eventName

String

click

行为查询值，只有type为EVENT时有效

eventType

Int

0

行为事件类型，0：普通事件；1:虚拟事件，可选，默认0

columnName

String

edu

字段列id，只有type为DETAIL时有效

rangeValues

Array

[]

区间维度，如果传入区间维度，则优先识别

dataSourceId

Int

2

数据源id，只有type为DETAIL时有效

propertyType

Int

1

属性类型，显示声明3是虚拟属性，其他都是普通属性，值为1

windowPeriod

BasePeriod

{}

窗口

dimColumnName

String

edu

维度属性名称

objDataPeriod

BasePeriod

{}

数据时间

dateGroupRange

String

DAY

日期维度聚合类型：YEAR、MONTH、WEEK、DAY、HOUR、MINUTE

dateSplitIndex

Int

0

日期维度切片位置

dateBasePeriods

Array

[]

自定义日期维度

dimDataSourceId

Int

37

维度属性数据源id

filterCondition

JsonNode

{}

过滤条件

eventAttributeId

Int

5

行为属性id，只有type为EVENT时有效

eventDatasourceId

Int

32

行为表id，只有type为EVENT时有效

eventAttributeName

String

pay

行为属性名称，只有type为EVENT时有效

attributeValueMapping

Map<String,Object>

{}

属性值mapping

analysisAttributionObjs

Array

[]

子节点信息

tagId

Int

1

标签id

values

Array

[小学,初中]

标签值

date

String

2022-02-01

人群日期

segName

String

测试上传分群

人群包名称

segFilter

JsonNode

{}

圈选条件

logic

String

Or

处理逻辑：Or、And、OR、AND

filters

Array

[]

具体过滤条件

attr

AttributionObj

{}

属性

value

Object

{}

值

values

Array

[点击,分享]

值列表

columnId

Int

1

列ID

operator

String

xx

操作

valueMap

Map<String,Object>

{}

值映射

paramName

String

param

前端组件问题, paramName 和 columnName 二选一

columnName

String

column

前端组件问题, paramName 和 columnName 二选一

operatorEnum

String

in

操作：
in、notIn、equal、less_than、less_equal_than、more_than、more_equal_than、not_equal

propertyType

Int

2

虚拟属性类型

dimColumnName

String

edu

虚拟属性名称

dimDataSourceId

Int

37

维度属性数据源id

eventAttributeId

Int

3

事件属性id

eventAttributeName

String

点击

事件属性名称

max

String

18

最大值

min

String

25

最小值

name

String

青少年

区间名称

leftClose

Boolean

true

是否包含最小值, 默认 true

rightClose

Boolean

true

是否包含最大值, 默认 false

num

Int

1

时间单位量

name

String

天

事件单位名称

type

String

RANGE

类型：
DATE
RANGE
ZONE

offset

Int

2

日期偏移

endTime

String

2020-01-01 10:00:00

结束时间

baseTime

String

2020-01-01 00:00:00

基准时间

startTime

String

2020-01-01 08:00:00

开始时间

periodRange

Sring

DAY

时间单位：
YEAR
MONTH
WEEK
DAY
HOUR
MINUTE

cdpModule

String

segAnalysis

模块名称

cdpModuleKeys

Array

[segAnalysis]

模块具体key

id

Number

1

分组id

name

String

默认分组

分组名称

status

String

NORMAL

分组状态：DELETED、FORBIDDEN、NORMAL

creator

String

admin

创建人

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。