You need to enable JavaScript to run this app.
导航
createAnalysisModuleObj - 创建指标
最近更新时间:2024.07.25 14:46:07首次发布时间:2024.07.10 15:50:04

请求说明

  • 请求方式: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

参数

类型

是否必选

示例值

描述

subjectId

Int

主体ID

type

String

类型,可选值包括: USER_TENDENCY

seg

Object

人群条件,参考JsonNode定义

dimension

Object

维度条件,参考BaseDimension定义

period

Object

时间周期,参考BasePeriod定义

metrics

Object

指标计算,参考BaseMetrics定义

withCache

Bool

使用历史计算结果

scheduleRange

String

离线运算类型,可选值包括: MANUAL

authFilter

Bool

是否使用行权限

name

String

指标名称

descr

String

指标描述

displayConfig

Object

前端展示结构,参考JsonNode定义

segRequired

Bool

是否需要传入人群条件

dimensionRequired

Bool

是否需要传入维度条件

periodRequired

Bool

是否需要传入时间周期

metricsRequired

Bool

是否需要传入指标条件

platform

String

应用平台/功能模块

hide

Bool

是否在通用了列表页中展示

analysisModuleObjId

Int

分析模块对象ID

onSchedule

Bool

是否开启定时任务

usableCdpModules

Array

可使用的CDP模块,每个元素为字符串

dateAggregate

Bool

日期聚合字段覆盖

enableOfflineQuery

Bool

是否启用离线查询

authUser

String

权限用户

analysisDashBoardRegisterInfo

Object

panel挂载信息,参考AnalysisDashBoardRegisterInfo定义

domainIds

Array

挂载的分组ID列表,每个元素为整数

authSchema

Object

权限结构,参考JsonNode定义

commonFilterSegRule

Object

额外交叉的人群规则,参考JsonNode定义

skipSqlOptimize

Bool

强制跳过规则简化拼接,因为规则优化的话,人群规则会触发特定日期的指定,对于效果分析等部分需要固定规则场景,会导致计算异常,默认false

返回参数

参数

类型

示例值

描述

msg

String

接口返回信息

code

Number

状态码,0表示正常

data

Int

接口返回数据体

traceId

String

跟踪id

请求示例


返回示例


错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。