跳到主要内容

元数据管理 API

最近更新 2026/10/03

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

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

一、事件管理​

1. 查询虚拟事件​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId377Integer是项目ID
eventNameta@test222String是事件名称

成功响应示例

{
    "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返回数据
data.eventDesc测试虚拟事件String事件显示名
data.eventNameta@tesetString事件名称
data.remark-String事件备注
data.rule-Object虚拟事件规则
data.rule.events-List事件列表
data.rule.events.eventDesc获得金币String事件显示名
data.rule.events.eventNameobtain_coinString事件名称
data.rule.events.filter-Object属性筛选器
data.rule.events.filter.filterTypeCOMPOUNDString

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
data.rule.events.filter filts[]List筛选值列表
data.rule.events.filter relationandString筛选逻辑关系
data.rule.filter-Object属性筛选器
data.rule.filter.filterTypeCOMPOUNDString

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
data.rule.filter.filts[]List筛选值列表
data.rule.filter.relationandString筛选逻辑关系
return_code0Integer返回码
return_messagesuccessString返回信息

2. 事件元信息列表​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId377Integer是项目ID

propName

-

String

否

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

成功响应示例

{
    "data": {
        "events": [
            {
                "eventDesc": "参加活动",
                "eventName": "activity_attend",
                "eventType": "event",
                "isHide": false,
                "remark": "参加活动321"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
$$参数名示例值参数类型参数描述
data-Object返回数据
data.events-List事件列表
data.events.eventDesc参加活动String事件描述
data.events.eventNameactivity_attendString事件名称
data.events.eventTypeeventString

事件类型

  • event：物理事件
  • event_v：虚拟事件
data.events.isHidefalseBoolean是否隐藏
data.events.remark参加活动321String事件备注
return_code0Integer返回码
return_messagesuccessString返回信息

3. 创建虚拟事件​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
overridefalseString是若同名虚拟事件已经存在，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"
            }
          ]
        }
      }
    ]
  }
}
$$参数名示例值参数类型是否必填参数描述
eventNameta@test_veventString是事件名称
eventDesc测试虚拟事件String否事件显示名
remarkString否事件备注
rule-Object是规则
rule.events-List是事件列表
rule.events.eventNameactivity_attendString是事件名称
rule.events.eventDesc参加活动String否事件显示名
rule.events.filter-Object否属性筛选器
rule.events.filter.filterTypeSIMPLEString否

筛选器

  • COMPOUND：复合类型
  • SIMPLE：简单类型
rule.events.filter.filts-List否筛选对象列表
rule.events.filter.filts.comparatorequalString否比较类型
rule.events.filter.filts.columnDesc网络类型String否字段显示名
rule.events.filter.filts.columnNamenetworkString是字段名称
rule.events.filter.filts.ftv["4G"]List否筛选值列表
rule.events.filter.filts.selectTypestringString否过滤值筛选框类型
rule.events.filter.filts.tableTypeeventString否event：事件属性，user：用户属性
rule.events.filter.filts.filterTypeSIMPLEString否

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
rule.events.filter.relationandString否筛选逻辑关系

成功响应示例

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

错误响应示例

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

4. 修改事件显示名和备注​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID

请求Body参数

{
    "eventName": "test007",
    "eventDesc": "testDesc",
    "eventRemark": "testRemark"
}
参数名示例值参数类型是否必填参数描述
eventNametestString是事件名称
eventDesctestDescString是事件显示名
eventRemarktestRemarkString否事件备注

成功响应示例

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

错误响应示例

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

5. 删除虚拟事件​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
eventNametestString是事件名称

成功响应示例

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

错误响应示例

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

二、属性管理​

1. 查询虚拟属性​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
propName#vp@locationString是属性名称
tableTypeeventString是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返回数据
data.relatedEvents-List关联事件列表
data.relatedEvents.eventName事件名称String事件名称
data.relatedEvents.eventDesc事件显示名String事件显示名
data.sqlEventRelationTyperelation_defaultString
  • relation_default：自动解析关联事件
  • relation_always：全部事件都是关联事件
  • relation_by_setting：关联事件在relatedEvents里
data.sqlExpressionconcat("#country",'-',"#province",'-',"#city")StringSQL表达式
data.vProp-Object虚拟属性列表
data.vProp.property-Object虚拟属性
data.vProp.property.columnDesc地理位置信息String字段显示名
data.vProp.property.columnName#vp@locationString字段名称
data.vProp.property.selectTypestringString过滤值筛选框类型
data.vProp.property.tableTypeeventString

属性类型

  • event：事件属性
  • user：用户属性
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

2. 属性列表​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
tableTypeeventString是

属性类型

  • 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返回数据
data.properties-List
data.properties.canCreateDicttrueBoolean是否可以创建维度表
data.properties.columnDesc活动项目def:123123123123123123String字段显示名
data.properties.columnNameactivity_item_operationString字段名称
data.properties.columnRemark-String字段说明
data.properties.dictProps-List关联维度字段
data.properties.dictProps.canCreateDictfalseString是否可以创建维度表
data.properties.dictProps.columnDesc-String字段显示名
data.properties.dictProps.columnNameactivity_item_operation@channel_nameString字段名称
data.properties.dictProps.columnRemark-String字段说明
data.properties.dictProps.isHidefalseBoolean是否隐藏
data.properties.dictProps.propTypevprop_dictString属性类型
data.properties.dictProps.selectTypestringString过滤值筛选框类型
data.properties.dictProps.tableTypeeventString字段所属表类型
data.properties.isHidefalseBoolean是否隐藏
data.properties.propTypeprop_unpresetString

属性类型

  • prop_preset：预置物理属性
  • prop_unpreset：自定义物理属性
  • vprop_dict：基于物理属性的维度表属性
  • vprop_sql：基于物理属性的虚拟属性
  • vprop_dict_v：基于虚拟属性的维度表属性
  • vprop_sql_v：基于维度表属性的虚拟属性
data.properties.selectTypestringString过滤值筛选框类型
data.properties.tableTypeeventString字段所属表类型
return_code0Integer返回码
return_messagesuccessString返回信息

3. 修改属性显示名​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID

请求Body参数

{
    "columnName": "test",
    "columnDesc": "testDesc",
    "columnRemark": "testRemark",
    "tableType": "event"
}
参数名示例值参数类型是否必填参数描述
columnNametestString是字段名称
columnDesctestDescString是字段显示名
columnRemarktestRemarkString否字段描述
tableTypetestTypeString是

属性类型

  • event：事件属性
  • user：用户属性

成功响应示例

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

错误响应示例

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

4. 维度字典校验和创建​

注意

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

接口URL

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

请求方式

POST

Content-Type

text/csv

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
createParamtestString是-

成功响应示例

{
    "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_code0String返回码
return_messagesuccessString返回信息
data-Object返回数据
data.totalLineNum4Integer解析总行数
data.successLineNum1Integer导入成功的行数
data.duplcatedMainKeyLineNum1Integer重复主键的行数
data.duplcatedMainKeyColumns["city@test"]List重复主键的行列表
data.mainKeyErrorLineNum1Integer错误主键类型的行数
data.mainKeyErrorColumns["brand@quantity"]List错误主键类型的行列表
data.typeErrorLineNum1Integer其他列包含类型错误的行数
data.typeErrorColumns["iswin@num"]List其他列包含类型错误的行列表
data.repeatWithConlumnName-List显示名与属性名重复列表
data.repeatWithConlumnName.columnNamechannel@channel_nameString属性字段名
data.repeatWithConlumnName.columnDesc渠道类型String属性显示名
data.repeatWithConlumnDesc-List显示名与显示名重复列表
data.repeatWithConlumnDesc.columnNamechannel@channel_nameString属性字段名
data.repeatWithConlumnDesc.columnDesc渠道类型String属性显示名

错误响应示例

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

5. 新建虚拟属性​

注意

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId110Integer是项目ID

请求Body参数

{
  "sqlExpression": "get_ip_location(\"#ip\")",
  "vProp" : {
    "property" : {
      "columnDesc": "IP地址解析的地理位置信息",
      "columnName": "#vp@location_array_from_ip",
      "tableType": "event",
      "selectType":"array"
    }
  },
  "sqlEventRelationType" : "relation_default"
}
$$参数名示例值参数类型是否必填参数描述
sqlExpressionget_ip_location(\"#ip\")String是SQL表达式
vProp-Object是虚拟属性信息
vProp.property-Object是虚拟属性信息

vProp.property.columnDesc

IP地址解析的地理位置信息

String

否字段名称
vProp.property.columnName#vp@location_array_from_ipString是

字段显示名

vProp.property.tableTypeeventString是

表类型

  • event：事件属性
  • user：用户属性
vProp.property.selectTypearrayString是过滤值筛选框类型
sqlEventRelationTyperelation_defaultString否

解析类型，默认relation_default

  • relation_default：自动解析关联事件
  • relation_always：全部事件都是关联事件
  • relation_by_setting：关联事件在relatedEvents里

成功响应示例

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

错误响应示例

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

6. 删除维度属性​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
tableTypeeventString是

属性类型

  • event：事件属性
  • user：用户属性
mainColumnNametestString是维度表所关联的主属性名称

成功响应示例

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

错误响应示例

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

7. 删除SQL虚拟属性​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
tableTypeeventString是

属性类型

  • event：事件
  • user：用户
propNametestString是属性名称

成功响应示例

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

错误响应示例

{
    "return_code": -1023,
    "return_message": "virtual event prop test不存在"
}
参数名示例值参数类型参数描述
return_code-1023Integer返回码
return_messagevirtual event prop test不存在String返回信息
这篇文档对你有帮助吗？
本页内容