创建指标 - createAnalysisModuleObj--客户数据平台-火山引擎

文档中心

导航

创建指标 - createAnalysisModuleObj

最近更新时间：2025.01.15 11:35:29首次发布时间：2024.07.12 14:50:49

请求说明

请求方式：POST
接口名称：createAnalysisModuleObj
请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数	类型	是否必选	示例值	描述
Authorization	String	是	HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx	详细介绍请查阅调用方式文档
X-Tenant	String	是	1	项目ID

Query

参数	类型	是否必选	示例值	描述
ApiAction	String	是	createAnalysisModuleObj	固定值，对应“请求说明”中的“接口名称”
ApiVersion	String	是	2024-05-22	固定值，版本号： 2024-05-22

Body

参数	类型	是否必选	示例值	描述
seg	JsonNode	否	{}	分群
hide	Boolean	否	false	是否在通用了列表页中展示
name	String	否	测试指标	指标名称
type	String	否	NORMAL	指标类型： USER_TENDENCY、TRANS、ATTRIBUTION、ATTRIBUTION_COLUMN、NORMAL、NORMAL_COLUMN、CROSS_DIMENSION、NORMAL_COLUMN_LINKAGE、NORMAL_COUNT、CROSS_DIMENSION_MERGE、EXTRA
descr	String	否	描述	指标描述
period	BasePeriod	否	{}	时间周期
metrics	BaseMetrics	是	{}	指标信息
authUser	String	否	admin	权限用户
platform	String	否	CDP	应用平台/功能模块
dimension	BaseDimension	否	{}	维度信息
domaninIds	Array	否	[1,2]	挂载的分组 id
subjectId	Number	否	1	主体ID
withCache	Boolean	否	false	使用历史计算结果
authFilter	Booolean	否	true	是否使用行权限
authSchema	JsonNode	否	{}	行权限过滤条件
onSchedule	Boolean	否	false	是否开启定时任务
segRequired	Boolean	否	true	是否需要传入人群条件
dateAggregate	Boolean	否	true	日期聚合字段覆盖
displayConfig	JsonNode	否	{}	前端展示配置
scheduleRange	String	否	DAILY	离线运算类型：MANUAL、DAILY、WEEKLY、MONTHLY
periodRequired	Boolean	否	true	是否需要传入时间周期
metricsRequired	Boolean	否	false	是否需要传入指标条件
skipSqlOptimize	Boolean	否	false	强制跳过规则简化拼接，因为规则优化的话，人群规则会触发特定日期的指定，对于效果分析等部分需要固定规则场景，会导致计算异常，默认false
usableCdpModules	Array	否	[segAnalysis]	可使用的cdp模块
dimensionRequired	Boolean	否	false	是否需要传入维度条件
enableOfflineQuery	Boolean	否	false	是否开启offline查询
analysisModuleObjId	Number	否	1	分析指标id
commonFilterSegRule	JsonNode	否	{}	自定义人群过滤条件
analysisDashBoardRegisterInfo	AnalysisDashBoardRegisterInfo	否	{}	看板信息

BasePeriod

参数	类型	示例值	描述
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

BaseMetrics

参数	类型	示例值	描述
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	[]	分析对象

FunctionObj

参数	类型	示例值	描述
nodes	Array	{}	节点
function	String	方法	方法

AnalysisAttributionObj

参数	类型	示例值	描述
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	[]	子节点信息

PathObj

参数	类型	示例值	描述
tagId	Int	1	标签id
values	Array	[小学,初中]	标签值

SegRuleObj

参数	类型	示例值	描述
date	String	2022-02-01	人群日期
segName	String	测试上传分群	人群包名称
segFilter	JsonNode	{}	圈选条件

EventAttributionObjCondition

参数	类型	示例值	描述
logic	String	Or	处理逻辑：Or、And、OR、AND
filters	Array	[]	具体过滤条件

EventAttributionFilter

参数	类型	示例值	描述
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	点击	事件属性名称

RangeValueObj

参数	类型	示例值	描述
max	String	18	最大值
min	String	25	最小值
name	String	青少年	区间名称
leftClose	Boolean	true	是否包含最小值, 默认 true
rightClose	Boolean	true	是否包含最大值, 默认 false

BaseDimension

参数	类型	示例值	描述
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

AnalysisDashBoardRegisterInfo

参数	类型	示例值	描述
dashBoardId	Number	1	挂载的dashBoardId，只有autoRegister为true时有效
autoRegister	Boolean	false	是否自动注册panel，默认false

返回参数

参数	类型	示例值	描述
msg	String	""	接口返回信息
code	Number	0	状态码，0表示正常
data	Int	2	接口返回数据体
traceId	String	xxx-xx-123	跟踪id

请求示例

{
    "dimension": {
        "type": "ATTRIBUTION_COLUMN",
        "attributionObj": {
            "type": "DETAIL",
            "dataSourceId": 95,
            "columnName": "money",
            "distinct": false,
            "breakUp": true,
            "method": "SUM"
        },
        "attributionEvent": [
            {
                "type": "EVENT",
                "eventDatasourceId": 105,
                "eventId": 118,
                "eventName": "click",
                "distinct": false,
                "breakUp": true,
                "method": "COUNT"
            }
        ]
    },
    "period": {
        "startTime": "2024-11-26",
        "endTime": "2024-12-03",
        "type": "DATE"
    },
    "metrics": {
        "method": "ATTRIBUTION",
        "period": {
            "periodRange": "DAY",
            "num": 7,
            "type": "RANGE"
        },
        "attributionType": "LAST",
        "formatEnum": "INTEGER",
        "attributionEvent": [
            {
                "type": "EVENT",
                "eventDatasourceId": 105,
                "eventId": 118,
                "eventName": "click",
                "distinct": false,
                "breakUp": true,
                "method": "COUNT"
            }
        ],
        "attributionObj": {
            "type": "DETAIL",
            "dataSourceId": 95,
            "columnName": "money",
            "distinct": false,
            "breakUp": true,
            "method": "SUM"
        }
    },
    "name": "openapi2024-12-03T15:26:42.171"
}

返回示例

{
    "code": 0,
    "msg": "success",
    "data": 1760
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	invalidParameter	PARAMETER INVALID	参数非法，检查入参。

客户数据平台