目录
此内容是否有帮助?

# 元数据管理 API

调用方法请参见Open API文档中的调用方法描述。

建议先阅读 TE 使用手册元数据管理部分了解相关功能:数据管理-事件和属性

# 一、事件管理

# 查询虚拟事件

接口 URL

/open/get-virtual-event-by-name?token=xxx&projectId=377&eventName=ta@test222

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
377
Integer

项目ID
eventName
ta@test222
String

事件名称

成功响应示例

{
    "data": {
        "eventDesc": "测试虚拟事件",
        "eventName": "ta@teset",
        "remark": "",
        "rule": {
            "events": [
                {
                    "eventDesc": "获得金币",
                    "eventName": "obtain_coin",
                    "filter": {
                        "filterType": "COMPOUND",
                        "filts": [],
                        "relation": "and"
                    }
                }
            ],
            "filter": {
                "filterType": "COMPOUND",
                "filts": [],
                "relation": "and"
            }
        }
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
eventDesc 测试虚拟事件
String
事件显示名
eventName ta@teset
String
事件名称
remark -
String
事件备注
rule -
Object
虚拟事件规则
events -
List
事件列表
eventDesc 获得金币
String
事件显示名
eventName obtain_coin
String
事件名称
filter -
Object
属性筛选器
filterType COMPOUND
String
筛选器,
COMPOUND:复合类型
SIMPLE:简单类型
filterfilts []
List
筛选值列表
filterrelation and
String
筛选逻辑关系
filter -
Object
属性筛选器
filterType COMPOUND
String
筛选器,
COMPOUND:复合类型
SIMPLE:简单类型
filts []
List
筛选值列表
relation and
String
筛选逻辑关系
return_code
0
Integer
返回码
return_message
success
String
返回信息

# 事件元信息列表

接口 URL

/open/list-event-meta?token=xxx&projectId=377

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
377
Integer

项目ID
propName
-
String

属性名称,该参数用于查询属性相关的事件。不传时返回所有物理事件和虚拟事件

成功响应示例

{
    "data": {
        "events": [
            {
                "eventDesc": "参加活动",
                "eventName": "activity_attend",
                "eventTag": "111,aaa",
                "eventType": "event",
                "isHide": false,
                "remark": "参加活动321"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
events -
List
事件列表
eventDesc 参加活动
String
事件描述
eventName activity_attend
String
事件名称
eventTag 111,aaa
String
事件标签
eventType event
String
事件类型
event:物理事件
event_v:虚拟事件
isHide false
Boolean
是否隐藏
remark 参加活动321
String
事件备注
return_code
0
Integer
返回码
return_message
success
String
返回信息

# 创建虚拟事件

接口 URL

/open/create-virtual-event?token=xxx&projectId=0&override=false

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
override
false
String

若同名虚拟事件已经存在,override=false时将报错,override=true时将更新虚拟事件定义。

请求 Body 参数

{
  "eventName": "ta@test_vevent",
  "eventDesc": "测试虚拟事件",
  "remark": "",
  "rule": {
    "events": [
      {
        "eventDesc": "参加活动",
        "eventName": "activity_attend",
        "filter": {
          "relation": "and",
          "filts": [
            {
              "comparator": "equal",
              "columnDesc": "网络类型",
              "columnName": "network",
              "ftv": [
                "4G"
              ],
              "selectType": "string",
              "tableType": "event"
            }
          ]
        }
      }
    ]
  }
}
参数名 示例值 参数类型 是否必填 参数描述
eventName
ta@test_vevent
String

事件名称
eventDesc
测试虚拟事件
String

事件显示名
remark
String

事件备注
rule
-
Object

规则
events -
List

事件列表
eventName activity_attend
String

事件名称
eventDesc 参加活动
String

事件显示名
filter -
Object

属性筛选器
filterType SIMPLE
String

筛选器
COMPOUND:复合类型
SIMPLE:简单类型
filts -
List

筛选对象列表
comparator equal
String

比较类型
columnDesc 网络类型
String

字段显示名
columnName network
String

字段名称
ftv ["4G"]
List

筛选值列表
selectType string
String

过滤值筛选框类型
tableType event
String

event:事件属性,user:用户属性
filterType SIMPLE
String

筛选器,
COMPOUND:复合类型
SIMPLE:简单类型
relation and
String

筛选逻辑关系

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "eventName 不能为空,rule 不能为null"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
eventName 不能为空,rule 不能为null
String
返回信息

# 修改事件显示名

注意

  • 事件显示名最长 60 字符,超出部分自动截断
  • 事件显示名不可包含 emoji 表情
  • 虚拟事件显示名不可与其他虚拟事件显示名和事件名重名
  • 物理事件显示名不可与其他物理事件显示名和事件名重名

接口 URL

/open/update-event-info?token=xxx&projectId=0

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID

请求 Body 参数

{
    "eventName": "test007",
    "eventDesc": "testDesc"
}
参数名 示例值 参数类型 是否必填 参数描述
eventName
test
String

事件名称
eventDesc
testDesc
String

事件显示名

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "事件test007已被隐藏或删除,请重新设置条件"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
事件test007已被隐藏或删除,请重新设置条件
String
返回信息

# 删除虚拟事件

接口 URL

/open/delete-virtual-event-by-name?token=xxx&projectId=0&eventName=test

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
eventName
test
String

事件名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "事件test已被隐藏或删除,请重新设置条件"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
String
返回码
return_message
事件test已被隐藏或删除,请重新设置条件
String
返回信息

# 二、属性管理

# 查询虚拟属性

接口 URL

/open/get-sql-prop-by-name?token=xxx&projectId=0&propName=%23vp@location&tableType=event

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
propName
#vp@location
String

属性名称
tableType
event
String

event:事件属性,user:用户属性

成功响应示例

{
    "data": {
        "relatedEvents": [
            {
                "eventName": "事件名称",
                "eventDesc": "事件显示名"
            }
        ],
        "sqlEventRelationType": "relation_default",
        "sqlExpression": "concat(\"#country\",'-',\"#province\",'-',\"#city\")",
        "vProp": {
            "property": {
                "columnDesc": "地理位置信息",
                "columnName": "#vp@location",
                "selectType": "string",
                "tableType": "event"
            }
        }
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
relatedEvents -
List
关联事件列表
eventName 事件名称
String
事件名称
eventDesc 事件显示名
String
事件显示名
sqlEventRelationType relation_default
String
relation_default:自动解析关联事
relation_always:全部事件都是关联事
relation_by_setting:关联事件在relatedEvents里
sqlExpression concat("#country",'-',"#province",'-',"#city")
String
SQL表达式
vProp -
Object
虚拟属性列表
property -
Object
虚拟属性
columnDesc 地理位置信息
String
字段显示名
columnName #vp@location
String
字段名称
selectType string
String
过滤值筛选框类型
tableType event
String
属性类型
event:事件属性
user:用户属性
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "用户属性test007已被隐藏或删除,请重新设置条件"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
用户属性test007已被隐藏或删除,请重新设置条件
String
返回信息

# 属性列表

接口 URL

/open/list-props?token=xxx&projectId=0&tableType=event&eventName=xxx

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
tableType
event
String

属性类型
event:事件属性
user:用户属性
eventName
-
String

tableType为event时有效。物理事件或虚拟事件的名称,该参数用于查询事件相关的属性。不传时返回所有物理属性和虚拟属性

成功响应示例

{
    "data": {
        "properties": [
            {
                "canCreateDict": true,
                "columnDesc": "活动项目def:123123123123123123",
                "columnName": "activity_item_operation",
                "columnRemark": "",
                "dictProps": [
                    {
                        "canCreateDict": false,
                        "columnDesc": "",
                        "columnName": "activity_item_operation@channel_name",
                        "columnRemark": "",
                        "isHide": false,
                        "propType": "vprop_dict",
                        "selectType": "string",
                        "tableType": "event"
                    }
                ],
                "isHide": false,
                "propType": "prop_unpreset",
                "selectType": "string",
                "tableType": "event"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
properties -
List
canCreateDict true
Boolean
是否可以创建维度表
columnDesc 活动项目def:123123123123123123
String
字段显示名
columnName activity_item_operation
String
字段名称
columnRemark -
String
字段说明
dictProps -
List
关联维度字段
canCreateDict false
String
是否可以创建维度表
columnDesc -
String
字段显示名
columnName activity_item_operation@channel_name
String
字段名称
columnRemark -
String
字段说明
isHide false
Boolean
是否隐藏
propType vprop_dict
String
属性类型
selectType string
String
过滤值筛选框类型
tableType event
String
字段所属表类型
isHide false
Boolean
是否隐藏
propType prop_unpreset
String
属性类型
prop_preset:预制物理属性
prop_unpreset:自定义物理属性
vprop_dict:基于物理属性的维度表属性
vprop_sql:基于物理属性的虚拟属性
vprop_dict_v:基于虚拟属性的维度表属性
vprop_sql_v:基于维度表属性的虚拟属性
selectType string
String
过滤值筛选框类型
tableType event
String
字段所属表类型
return_code
0
Integer
返回码
return_message
success
String
返回信息

# 修改属性显示名

注意

  1. 属性显示名最长 60 字符,超出部分自动截断,不可包含 emoji 表情,虚拟属性不可与其他虚拟属性显示名和属性名重名,物理属性不可与其他物理属性显示名和属性名重名
  2. 属性描述最长 200 字符,超出部分自动截断
  3. 若同名虚拟属性已经存在,则更新虚拟属性定义

接口 URL

/open/update-prop-info?token=xxx&projectId=0

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID

请求 Body 参数

{
    "columnName": "test",
    "columnDesc": "testDesc",
    "columnRemark": "testRemark",
    "tableType": "event"
}
参数名 示例值 参数类型 是否必填 参数描述
columnName
test
String

字段名称
columnDesc
testDesc
String

字段显示名
columnRemark
testRemark
String

字段描述
tableType
testType
String

属性类型
event:事件属性
user:用户属性

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "event property(test)不存在"
}
参数名 示例值 参数类型 参数描述
return_code
-1023
Integer
返回码
return_message
event property(test)不存在
String
返回信息

# 维度字典校验和创建

注意

文件上传方式创建维度字典,文件大小限制 200M

接口 URL

/open/dict-create?token=xxx&projectId=0&createParam=test

请求方式

POST

Content-Type

text/csv

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
createParam
test
String

-

成功响应示例

{
    "data": {
        "totalLineNum": 4,
        "successLineNum": 1,
        "duplcatedMainKeyLineNum": 1,
        "duplcatedMainKeyColumns": ["city@test"],
        "mainKeyErrorLineNum": 1,
        "mainKeyErrorColumns": ["brand@quantity"],
        "typeErrorLineNum": 1,
        "typeErrorColumns": ["iswin@num"],
        "repeatWithConlumnName": [{
            "columnName": "channel@channel_name",
            "columnDesc": "渠道类型"
        }],
        "repeatWithConlumnDesc": [{
            "columnName": "channel@channel_name",
            "columnDesc": "渠道类型"
        }]
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
String
返回码
return_message
success
String
返回信息
data
-
Object
返回数据
totalLineNum 4
Integer
解析总行数
successLineNum 1
Integer
导入成功的行数
duplcatedMainKeyLineNum 1
Integer
重复主键的行数
duplcatedMainKeyColumns ["city@test"]
List
重复主键的行列表
mainKeyErrorLineNum 1
Integer
错误主键类型的行数
mainKeyErrorColumns ["brand@quantity"]
List
错误主键类型的行列表
typeErrorLineNum 1
Integer
其他列包含类型错误的行数
typeErrorColumns ["iswin@num"]
List
其他列包含类型错误的行列表
repeatWithConlumnName -
List
显示名与属性名重复列表
columnName channel@channel_name
String
属性字段名
columnDesc 渠道类型
String
属性显示名
repeatWithConlumnDesc -
List
显示名与显示名重复列表
columnName channel@channel_name
String
属性字段名
columnDesc 渠道类型
String
属性显示名

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名 示例值 参数类型 参数描述
return_code
-3004
String
返回码
return_message
无效项目
String
返回信息

# 新建虚拟属性

注意

若同名虚拟属性已经存在,则更新虚拟属性定义

接口 URL

/open/create-sql-prop?token=xxx&projectId=110

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
110
Integer

项目ID

请求 Body 参数

{
  "sqlExpression": "get_ip_location(\"#ip\")",
  "vProp" : {
    "property" : {
      "columnDesc": "IP地址解析的地理位置信息",
      "columnName": "#vp@location_array_from_ip",
      "tableType": "event",
      "selectType":"array"
    }
  },
  "sqlEventRelationType" : "relation_default",
}
参数名 示例值 参数类型 是否必填 参数描述
sqlExpression
get_ip_location(\"#ip\")
String

SQL表达式
vProp
-
Object

虚拟属性信息
property -
Object

虚拟属性信息
columnDesc IP地址解析的地理位置信息
String

字段名称
columnName #vp@location_array_from_ip
String

字段显示名
tableType event
String

表类型
event:事件属性
user:用户属性
selectType array
String

过滤值筛选框类型
sqlEventRelationType
relation_default
String

解析类型,默认relation_default
relation_default:自动解析关联事件
relation_always:全部事件都是关联事件
relation_by_setting:关联事件在relatedEvents里

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
String
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名 示例值 参数类型 参数描述
return_code
-3004
String
返回码
return_message
无效项目
String
返回信息

# 删除维度属性

接口 URL

/open/delete-dict-props?token=xxx&projectId=0&tableType=event&mainColumnName=test

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
tableType
event
String

属性类型
event:事件属性
user:用户属性
mainColumnName
test
String

维度表所关联的主属性名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "事件属性test已被隐藏或删除,请重新设置条件"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
事件属性test已被隐藏或删除,请重新设置条件
String
返回信息

# 删除 SQL 虚拟属性

接口 URL

/open/delete-sql-prop-by-name?token=xxx&projectId=0&tableType=event&propName=test

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
tableType
event
String

属性类型
event:事件
user:用户
propName
test
String

属性名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "virtual event prop test不存在"
}
参数名 示例值 参数类型 参数描述
return_code
-1023
Integer
返回码
return_message
virtual event prop test不存在
String
返回信息