You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/数据档案/按事件获取事件属性列表 - QueryeventPropertyList
按事件获取事件属性列表 - QueryeventPropertyList
最近更新时间：2024.12.06 13:08:26首次发布时间：2024.07.12 14:50:50
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：QueryeventPropertyList
  • 请求地址：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

Int

是

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

QueryeventPropertyList

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

ApiVersion

String

是

2023-02-10

固定值，版本号：2023-02-10

eventId

Int

是

事件id

Body

无

返回参数

data数组元素字段内容

参数

类型

示例值

描述

id

Int

0

事件属性id

eventPropertyId

Int

事件属性id,别名

eventId

Int

0

所属事件id,不同接口场景可能为null

enName

String

string

事件属性名

cnName

String

string

事件属性展示名

expr

String

string

属性表达式

dataType

String

string

数据类型

description

String

string

描述

originId

String

0

原始id

isDisplay

Bool

true

是否显示

editBan

Bool

true

是否可编辑

dataSourceId

Int

0

数据源id

dataSourceName

String

string

数据源名

sourceTag

String

string

数据源注册来源

sourceType

Int

0

数据源类型

请求示例

无

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "id": 4,
            "eventId": 4,
            "enName": "shareInvite",
            "cnName": "好友邀请分享_11131836",
            "description": "autotest",
            "eventType": 0,
            "originId": 4,
            "expr": "(event = 'shareInvite')",
            "isDynamicExpr": false,
            "editBan": false,
            "isDisplay": true,
            "status": 1,
            "groupName": "未分类",
            "groupType": 0,
            "createTime": "2024-11-13 19:52:08",
            "updateTime": "2024-11-13 19:52:08",
            "platform": [

            ],
            "dataSourceId": 37,
            "dataSourceName": "autotest_event11131836",
            "sourceTag": "inner",
            "sourceType": 3
        },
        {
            "id": 7,
            "eventId": 7,
            "enName": "wechatAuthorize",
            "cnName": "微信授权_11131836",
            "description": "autotest",
            "eventType": 0,
            "originId": 7,
            "expr": "(event = 'wechatAuthorize')",
            "isDynamicExpr": false,
            "editBan": false,
            "isDisplay": true,
            "status": 1,
            "groupName": "未分类",
            "groupType": 0,
            "createTime": "2024-11-13 19:52:09",
            "updateTime": "2024-11-13 19:52:09",
            "platform": [

            ],
            "dataSourceId": 37,
            "dataSourceName": "autotest_event11131836",
            "sourceTag": "inner",
            "sourceType": 3
        }
    ]
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。