添加事件属性

POST

/leads/open-api/add-event-attr

最后修改时间：2023-11-22 08:23:15

接口描述

新增事件属性

请求参数说明

参数名称	参数类型	必须	说明
display_name	string	是	事件属性显示名称
attribute_name	string	是	事件属性字段名称（大小写字母及数字组合）
data_type	string	是	属性类型(支持类型 'Number','Text','DateTime','Select')
desc	string	否	事件属性描述
units	string	否	事件类型为Number类型时，单位描述

返回参数说明

参数名称	说明
code	返回码
msg	错误信息
data	数据集

请求参数

Query 参数

access_token

string

必需

通过鉴权模块-获取token接口

示例值:

moaCz9-6JH0SDNSGmERucIyZzOgJiZ_VLHJgKco6uu4PIrbvNjJfGgsrlzrheC3XspscmE5WOmmLmwph0qOuQcnoz2AHt5YnBZLyqmtf7d0gMooO_gB_BzXL4la1lOUN

Body 参数application/json

display_name

string

事件属性显示名称（汉字）

必需

attribute_name

string

事件属性字段名称（大小写字母及数字组合）

必需

data_type

string

属性类型

必需

'Number'：数字类型
'Text'：文本类型
'DateTime'：日期事件类型，数据必须为Unix时间戳（Unix timestamp）格式。10位数字。例：1675947951。
'Select' ：选项类型

desc

string

事件属性描述

可选

units

array [object {2}]

单位

可选

与Number类型同在

name

string

可选

value

string

可选

示例

{
  "display_name": "测试属性-API",
  "attribute_name": "ce-api1",
  "data_type": "Number",
  "desc": "属性描述",
  "units": [
    {
      "name": "秒",
      "value": "s"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.beschannels.com/leads/open-api/add-event-attr?access_token=moaCz9-6JH0SDNSGmERucIyZzOgJiZ_VLHJgKco6uu4PIrbvNjJfGgsrlzrheC3XspscmE5WOmmLmwph0qOuQcnoz2AHt5YnBZLyqmtf7d0gMooO_gB_BzXL4la1lOUN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "display_name": "测试属性-API",
    "attribute_name": "ce-api1",
    "data_type": "Number",
    "desc": "属性描述",
    "units": [
        {
            "name": "秒",
            "value": "s"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

msg

string

错误信息

必需

data

object

必需

integer

事件id

必需

示例

{
  "code": 0,
  "msg": "成功",
  "data": {
    "id": 1830
  }
}

修改于 2023-11-22 08:23:15

获取事件

获取事件属性

添加事件属性

接口描述#

请求参数说明#

返回参数说明#

请求参数

示例代码

返回响应

接口描述

请求参数说明

返回参数说明