文档中心

客户数据平台

普通接口

标签相关

1. 获取所有标签列表，包含各个标签的取值（计划逐步下线，建议使用 15 新接口）

基本信息

生效版本	1.12
废弃版本	1.20
功能描述	按租户获取标签列表，在sass环境，租户和集团关联，会自动按租户绑定的集团过滤
接口模块	TagApi
接口名称	GetTagsList
请求类型	GET
权限校验	有资源权限校验

请求参数

query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)
idType	Int	是	标签的idtype ,传每个主体下面的base id 的id。
discardValue	bool	否	是否移除标签取值。默认是false。后续默认值会调整为true。因为会严重影响性能.
withOnlineFlag	bool	否	是否包含在线服务信息，默认不包含

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Body（无）

响应参数

名称	数据类型	描述
data	list	标签取值
data[index]	object	标签目录
domainId	int	标签目录id
domainName	string	标签目录展示名
tags	list	当前目录下的标签列表
tags[index].id	int	标签id
tags[index].name	string	标签名
tags[index].code	string	已废弃，不建议使用
tags[index].dataType	string	标签数据类型. 现存的标签类型有10种.但是因为本接口的发布时间比较早，所以类型和真实情况不符合，下面有新旧数据类型的映射关系。 array_string, array_bigint, array_double, array_date, array_datetime -> Array bigint，double -> Decimal string -> String date, datetime -> Date
tags[index].featureDataType	string	当前建议使用的数据类型，有以下十种： bigint, array_bigint double, array_double date, array_date datetime, array_datetime string, array_string
tags[index].createWay	string	标签创建类型。all, calcu, rule, `import`, manual, sql, logic, combine, ml_model, etl_model, clickhouse_sql, hive_sql, model, multi_stage, mautag, rfm, statistics, first_last, volcengine, preference, industry_model, intelligent_hear, out_call。具体类型解释请咨询标签侧同学
tags[index].value	object	该参数受discardValue控制，强烈建议设为true，用点查接口代替
tags[index].onlineServiceAvailable	bool	是否开启在线服务导入，默认为false

返回示例：

获取所有标签列表，包含各个标签的取值.json

65.06KB

2. 获取某个标签的取值（计划逐步下线，建议使用 16 新接口）

基本信息

生效版本	1.12
废弃版本	1.20
功能描述	按租户获取标签取值，在sass环境，租户和集团关联，会自动按租户绑定的集团过滤
接口模块	TagApi
接口名称	GetTagValues
请求类型	GET
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)
tagId	Int	是	标签id

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Body（无）

响应参数

名称	数据类型	描述
data	list	标签取值
data[index]	object	数字型人工标签取值， name=minValue代表数字的最大值 name=maxValue代表数字的最大值
data[index]	string	其他标签取值

返回示例：

{ // 范围型标签
  "data": [
    {
      "name": "minValue",
      "value": 1
    },
    {
      "name": "maxValue",
      "value": 100
    },
    {
      "name": "unit",
      "value": null
    }
  ],
  "code": 0
}


{ // 枚举型标签
  "data": [
    "男",
    "女"
  ],
  "code": 0
}

{ // 无法确定取值标签
  "data": [],
  "code": 0
}

3. 添加或者修改某个用户身上的人工标签（计划逐步下线，建议使用 17 新接口）

基本信息

生效版本	1.5
废弃版本	1.20
功能描述	添加或者修改某个用户身上的人工标签
接口模块	TagApi
接口名称	AddOrModifyManualTags
请求类型	POST
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Body

名称	数据类型	是否必选	描述
idFilter	Object	是	修改的对象，type表示id的类型。
newTagValues	Object	是	更新哪些标签

请求样例

{
  "idFilter": {
    "id": "1111111111",
    "type": "baseid"
  },
  "newTagValues": [
    {
      "tagId": 15,
      "value": ["男","女"] 
    },
   {
      "tagId": 16,
      "value": 123
    },
   {
      "tagId": 17,
      "value": 12.13 
    },
   {
      "tagId": 18, 
      "value": "abc"
    }
  ]
}

响应参数

名称	数据类型	描述
data	String	成功更新信息

响应样例

正确

{
  "data": "成功更新标签15的值至男 女",
  "code": 0
}

错误

{
  "msg": "15修改失败，失败原因：[0220人工多值01 标签值创建失败，可填写的值包括：[\"男\", \"1\", \"3\", \"2\", \"女\", \"5\", \"6\", \"哈哈\", \"7\", \"8\", \"9\", \"4949\", \"101111\", \"11\", \"你还\", \"12\", \"90\", \"00\", \"ok\"]]",
  "code": 400
}

4. 删除某个用户身上的人工标签（计划逐步下线，建议使用 18 新接口）

基本信息

生效版本	1.5
废弃版本	1.20
功能描述	删除某个用户身上的人工标签
接口模块	TagApi
接口名称	DeleteManualTagsInUser
请求类型	DELETE
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)
baseId	Int	是	baseid
tagId	Int	是	标签id

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

请求样例

curl --location --request POST 'http://xxxxx/open_platform/openapi?ApiAction=DeleteManualTagsInUser&ApiVersion=2023-02-10&tenantCode=1&baseId=3&tagId=42' \
--header 'Authorization: HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE/20201230/cn-north-1/iam/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=28eeabbbd726b87002e0fe58ad8c1c768e619b06e2646f35b6ad7ed029a6d8a7'

响应参数

名称	数据类型	描述
data	String	成功信息

响应样例

正确

{
  "data": "OK",
  "code": 0
}

5. 获取人工标签列表（计划逐步下线，建议使用 15 新接口）

基本信息

生效版本	1.12+
废弃版本	1.20
功能描述	根据租户code获取该租户下所有人工标签
接口模块	TagApi
接口名称	GetManualTagsList
请求类型	GET
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

响应参数

名称	数据类型	描述
tagId	Int	标签id
tagName	String	标签名称
tagValues/tagBounds	Array/object	标签可能取值 / 标签取值范围

响应样例

成功
响应样例-获取人工标签列表.json
8.63KB
失败

{
  "msg": "ERROR",
  "code": -1,
  data: null
}

6. 添加或者修改某个用户身上的实时标签（计划逐步下线，建议使用 17 新接口）

基本信息

生效版本	1.8
废弃版本	1.20
功能描述	添加或者修改某个用户身上的实时标签
接口模块	OnlineApi
接口名称	AddOrModifyRealtimeTag
请求类型	PUT
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户Code (请不要填写租户ID，获取方式详见附录)

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Body

名称	数据类型	是否必选	描述
tagId	String	是	标签id
tagValue	String	是	标签值
idType	String	是	id类型
id	long	是	id值
check	boolean	是	必传false 如果为false ,则不会检测数据是否是按照规定的范围传过来。如果为true, 则会校验数据的合规性。比如标签A规定了数据的上下限，上限是100，下限是10，如果修改后的值是5， check=true, 则请求会直接报错

请求样例

{
    "tagId": 228,
    "tagValue": "lalalaghhhh",
    "idType": "baseid",
    "id": 123,
    "check": false
}

响应参数

名称	数据类型	描述
extra	String	额外错误信息

响应样例

正确

{
    "code": 0,
    "msg": "",
    "extraMsg": "",
    "message": "",
    "data": []
}

错误

{
        "code": -10200,
        "extra": "[invalid character '<' looking for beginning of value]",
        "msg": "json unmarshal error"
}

7. 获取标签信息

基本信息

生效版本	1.18
功能描述	查询标签信息（标签最近同步结束时间、标签描述、标签所属标签树）
接口模块	LabelApi
接口名称	GetLabelDesc
请求类型	GET
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
id	Int	是	标签id

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body（无）

响应参数

名称	数据类型	描述
desc	String	标签描述
domainName	String	标签所属标签树名称
syncEndTime	String	标签最近同步时间

响应样例

正确

{
    "code": 0,
    "msg": "",
    "data": {
        "desc": "",
        "domainName": "系统标签",
        "syncEndTime": "2023-01-31 01:15:15"
    }
}

8. 获取标签树信息

基本信息

生效版本	1.18
功能描述	获取标签树信息
接口模块	LabelApi
接口名称	GetLabelTree
请求类型	GET
权限校验	有资源和模块权限校验

请求参数

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
subjectId	Int	否	主体id（不传默认为1）

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body（无）

响应参数

名称	数据类型	描述
id	Int	标签ID
preNodeId	Int	前端展示，排序相关
subjectId	Int	主体ID
projectId	Int	项目ID
name	String	标签名称
desc	String	标签描述
nodeType	String	System: 系统标签 default : 未分类 Normal:其他的
createTime	String	标签创建时间
updateTime	String	标签修改时间
index	Int	排序，顺序相关
level	Int	排序，层级相关
labelCount	Int	当前标签树下的所有标签数量
display	Bool	前端展示，是否展示，前端搜索不符合时为false
subNodes	Object	子节点

entityType：

用户定义的ID类型code，没有枚举值

labelType枚举:

rule、import、manual、combine、logic、ml_model、etl_model、clickhouse_sql、hive_sql、multi_stage、rfm、statistics、mautag、first_last、industry_model、out_call、preference、intelligent_hear

dataType枚举：

string、bigint、double、date、datetime、array_string、array_bigint、array_double、array_date、array_datetime

computeType枚举:

offline、realtime
响应样例

正确

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "id":2,
            "preNodeId":null,
            "subjectId":1,
            "projectId":1,
            "name":"123",
            "desc":null,
            "nodeType":"Normal",
            "createTime":"2023-01-18 19:37:07",
            "updateTime":"2023-01-18 19:37:07",
            "index":0,
            "level":1,
            "labelCount":0,
            "display":true,
            "subNodes":[
                {
                    "id":3,
                    "preNodeId":2,
                    "subjectId":1,
                    "projectId":1,
                    "name":"222",
                    "desc":null,
                    "nodeType":"Normal",
                    "createTime":"2023-01-18 19:37:12",
                    "updateTime":"2023-01-18 19:37:12",
                    "index":0,
                    "level":2,
                    "labelCount":0,
                    "display":true,
                    "subNodes":[

                    ],
                    "labelInfos":[

                    ]
                }
            ],
            "labelInfos":[

            ]
        },
        {
            "id":-1,
            "preNodeId":null,
            "subjectId":1,
            "projectId":1,
            "name":"系统标签",
            "desc":null,
            "nodeType":"System",
            "createTime":"1970-01-01 00:00:00",
            "updateTime":"1970-01-01 00:00:00",
            "index":null,
            "level":1,
            "labelCount":1,
            "display":true,
            "subNodes":[

            ],
            "labelInfos":[
                {
                    "id":1,
                    "name":"主体1_全量",
                    "subjectId":1,
                    "projectId":1,
                    "orgId":1,
                    "entityId":1,
                    "entityType":"baseid",
                    "labelType":"mautag",
                    "dataType":"bigint",
                    "conf":null,
                    "creator":"admin",
                    "status":0,
                    "desc":"",
                    "createTime":"2023-01-10 20:12:31",
                    "updateTime":"2023-01-10 20:12:33",
                    "computeType":"realtime",
                    "isMautag":1,
                    "syncParams":{
                        "scheduleConf":{
                            "frequency":"d",
                            "scheduleTime":"00:00:00"
                        },
                        "syncType":1
                    },
                    "taskId":100000016,
                    "dimMetId":339,
                    "updater":"admin",
                    "dataSecurityLevel":"L3",
                    "createApiTask":false,
                    "env":null,
                    "syncStatus":null,
                    "syncTime":null,
                    "syncId":null,
                    "nodeId":-1,
                    "index":1,
                    "readable":true,
                    "isCollected":true,
                    "isTemplateLabel":false,
                    "isOnlineService":false,
                    "refreshFreqDetails":null,
                    "coverage":"100.00%"
                }
            ]
        },
        {
            "id":-2,
            "preNodeId":null,
            "subjectId":1,
            "projectId":1,
            "name":"未分类",
            "desc":null,
            "nodeType":"Default",
            "createTime":"1970-01-01 00:00:00",
            "updateTime":"1970-01-01 00:00:00",
            "index":null,
            "level":1,
            "labelCount":1,
            "display":true,
            "subNodes":[

            ],
            "labelInfos":[
                {
                    "id":23,
                    "name":"测试",
                    "subjectId":1,
                    "projectId":1,
                    "orgId":1,
                    "entityId":1,
                    "entityType":"baseid",
                    "labelType":"rule",
                    "dataType":"string",
                    "conf":null,
                    "creator":"admin",
                    "status":0,
                    "desc":"",
                    "createTime":"2023-01-17 13:58:50",
                    "updateTime":"2023-01-29 20:32:55",
                    "computeType":"offline",
                    "isMautag":0,
                    "syncParams":{
                        "scheduleConf":{
                            "frequency":"d",
                            "scheduleTime":"00:00:00"
                        },
                        "syncType":1
                    },
                    "taskId":100000070,
                    "dimMetId":664,
                    "updater":"admin",
                    "dataSecurityLevel":null,
                    "createApiTask":true,
                    "env":null,
                    "syncStatus":null,
                    "syncTime":null,
                    "syncId":null,
                    "nodeId":-2,
                    "index":12,
                    "readable":true,
                    "isCollected":false,
                    "isTemplateLabel":false,
                    "isOnlineService":false,
                    "refreshFreqDetails":"每天 时间: 00:00:00",
                    "coverage":"100.00%"
                }
            ]
        }
    ]
}

9. 查询标签最新结果

基本信息

生效版本	1.19
功能描述	根据标签id获取标签最新计算结果
接口模块	LabelApi
接口名称	GetLatestHistoryData
请求类型	GET
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20
id	Int	是	标签id
showNum	Int	是	标签值数量

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body 格式如下

响应参数

名称	数据类型	描述
scheduleTime	String	最近调度日期
distinctNumber	Int	标签包含用户数
coverage	String	标签覆盖用户数的覆盖率
statistics	Array
statistics.count	Int	单个标签值的用户数
statistics.originValue	String	标签值
statistics.tagCoverage	String	标签值在当前标签人数中的覆盖率
statistics.totalCoverage	String	标签值在总人数中的覆盖率
queryMauCost	Int	查询全量标签花费时间
queryDataCost	Int	查询当前标签花费时间

响应样例

{
    "code":0,
    "msg":"成功",
    "data":{
        "scheduleTime":"2023-04-25",
        "distinctNumber":5124,
        "coverage":"100.00%",
        "statistics":[
            {
                "count":5124,
                "originValue":"标签值1",
                "mappingValue":"标签值1",
                "tagCoverage":"100.00%",
                "totalCoverage":"100.00%"
            }
        ],
        "queryMauCost":16,
        "queryDataCost":160
    }
}

10. 查询标签历史计算结果

基本信息

生效版本	1.19
功能描述	根据标签id获取标签历史计算结果
接口模块	LabelApi
接口类型	GetHistoryData
请求类型	GET
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20
showNum	Int	是	标签值数量
startDate	String	是	开始日期
endDate	String	是	结束日期

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body格式如下

响应参数

名称	数据类型	描述
scheduleTime	String	最近调度日期
distinctNumber	Int	标签包含用户数
coverage	String	标签覆盖用户数的覆盖率
statistics	Array
statistics.count	Int	单个标签值的用户数
statistics.originValue	String	标签值
statistics.tagCoverage	String	标签值在当前标签人数中的覆盖率
statistics.totalCoverage	String	标签值在总人数中的覆盖率
queryMauCost	Int	查询全量标签花费时间
queryDataCost	Int	查询当前标签花费时间

响应样例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "scheduleTime":"2023-04-20",
            "distinctNumber":0,
            "coverage":"0.00%",
            "statistics":[
                {
                    "count":0,
                    "originValue":"标签值1",
                    "mappingValue":"标签值1",
                    "tagCoverage":"NA",
                    "totalCoverage":"0.00%"
                }
            ],
            "queryMauCost":15,
            "queryDataCost":148
        },
        {
            "scheduleTime":"2023-04-23",
            "distinctNumber":5124,
            "coverage":"100.00%",
            "statistics":[
                {
                    "count":5124,
                    "originValue":"标签值1",
                    "mappingValue":"标签值1",
                    "tagCoverage":"100.00%",
                    "totalCoverage":"100.00%"
                }
            ],
            "queryMauCost":15,
            "queryDataCost":148
        }
    ]
}

11. 查询项目下标签列表

基本信息

生效版本	1.19
功能描述	根据项目id获取项目下标签列表
接口模块	LabelApi
接口名称	GetLabels
请求类型	GET
权限校验	有模块和资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20
subjectId	Int	否	主体id

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body格式如下

响应参数

名称	数据类型	描述
id	Int	标签ID
name	String	标签名称
orgId	Int	集团ID
projectId	Int	项目ID
descr	String	描述
dataSecurityLevel	Int	安全等级（暂废弃）
labelType	String	创建方式： rule（规则） import（导入） manual（人工） logic （逻辑） combine （组合） ml_model（机器学习模型） etl_model（数据清洗模型） hive_sql（hive sql标签） clickhouse_sql （ch sql标签） multi_stage（多阶段） rfm （rfm） preference（偏好）
dataTypeName	String	标签值类型：文本型：string 数值型：bigint 小数型：double 多值文本型：array_string 日期型：date 时间日期型：datetime 多值数值型：array_bigint 多值日期型：array_date 多值日期时间型：array_datetime
domainId	Int	所属标签目录路径id
position	Int	当前子节点目录排序
entityId	Int	ID类型的编号
entityType	String	ID类型名称
computeType	String	更新方式： offline: 离线，realtime: 实时
isMautag	Int	是否为标识“全量用户”的标签（可不关注）
syncParams	Object	调度信息（下含数组）
scheduleConf	Object	调度配置： "scheduleDay: [] 数字为实际天数-1，例如周级调度：0 - 星期一，1 - 星期二，以此类推月级调度：0 - 1号，1 - 2号，以此类推"
frequency	String	运行周期：d：按天，w：按周，m：按月
syncType	Int	更新频率：1是周期，2是手动
scheduleTime	String	指定更新时刻
conf	Object	标签规则（下含数组）
layers	Array	条件组
operator	String	条件间关系操作符：and,or
tagId	Int	规则中包含的标签ID
value	Int	取值
taskId	Int	任务ID
dimMetId	Int	-（可不关注）
labelRangeRules	String	人工标签规则
status	Int	标签状态：状态机：0-正常，1-删除
createApiTask	Bool	是否导入在线服务
realtimeTaskId	Int	实时任务ID（仅实时标签有该字段）
realtimeStatus	String	实时任务最新状态（仅实时标签有该字段）
owner	String	创建人
createTime	String	创建时间
updater	String	最新编辑人
updateTime	String	最新编辑时间
abiDimMetId	Int	-（可以不关注）
lastSuccessTaskInstanceId	Int	最后更新成功的任务ID
latestRunDate	String	最后更新时间：返回格式 yyyy-MM-dd
userNum	Int	覆盖用户数
values	String	枚举值

响应样例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "id":4,
            "name":"autotest_quanliang03181231",
            "orgId":1,
            "projectId":1,
            "descr":"",
            "dataSecurityLevel":null,
            "labelType":"rule",
            "dataTypeName":"string",
            "domainId":-2,
            "position":3,
            "entityId":1,
            "entityType":"baseid",
            "computeType":"offline",
            "isMautag":0,
            "syncParams":{
                "scheduleConf":{
                    "frequency":"d",
                    "scheduleTime":"02:00:00"
                },
                "syncType":1
            },
            "conf":{
                "layers":[
                    {
                        "filter":{
                            "operator":"And",
                            "filters":[
                                {
                                    "operator":"And",
                                    "filters":[
                                        {
                                            "operator":"=",
                                            "tagId":3,
                                            "value":0
                                        }
                                    ]
                                }
                            ]
                        },
                        "name":"标签值1"
                    }
                ]
            },
            "taskId":100000018,
            "dimMetId":282,
            "labelRangeRules":null,
            "status":0,
            "createApiTask":false,
            "realtimeTaskId":null,
            "realtimeStatus":null,
            "owner":"admin",
            "createTime":"2023-03-18 12:42:47",
            "updater":"admin",
            "updateTime":"2023-03-18 12:42:50",
            "abiDimMetId":0,
            "lastSuccessTaskInstanceId":1192,
            "latestRunDate":"2023-04-25",
            "userNum":5124,
            "values":null
        }
    ]
}

12. 触发标签计算

基本信息

生效版本	1.19
功能描述	根据标签id触发标签计算
接口模块	LabelApi
接口类型	RerunLabel
请求类型	POST
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body

名称	数据类型	是否必选	描述
labelId	Int	是	标签id
startDate	String	是	开始日期
endDate	String	是	结束日期

响应参数

名称	数据类型	描述
code	Int	状态码：0 为成功。错误码见附录3
msg	String	状态信息

响应样例

{
    "code":0,
    "msg":"成功",
    "data":null
}

13. 上传标签数据

基本信息

生效版本	1.19
功能描述	上传标签数据文件
接口模块	LabelApi
接口名称	UploadLabelData
请求类型	POST
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Int	是	项目id

Body

名称	数据类型	是否必选	描述
file	file	是	文件内容

响应参数

名称	数据类型	描述
dataModelId	int	上传文件id

响应样例

正确

{
  "code": 0, 
  "data": {
    "dataModelId": 376
  }, 
  "msg": ""
}

14. 创建人工标签

基本信息

生效版本	1.19
功能描述	创建人工标签
接口模块	LabelApi
接口名称	CreateManualLabel
请求类型	POST
权限校验	有资源权限校验

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20

Header

名称	数据类型	是否必选	描述
Authorization	String	是	Token，以 “Bearer ”开头（注意：Bearer后有空格）

Body

名称	数据类型	是否必选	描述
name	String	是	标签名称
labelEntityType	String	是	标签实体类型
appId	Int	是	项目id
descr	String	否	标签描述
dataTypeName	String	是	标签数据类型
conf	Json	否	标签配置，如果需要上传文件可以配置其中的manualProperty，dataModelId为14.上传标签数据文件接口返回id
labelRangeRules	Json	是	人工标签枚举值规则文本&多值文本类型规则： `"labelRangeRules": { "value": { "enumValue": ["男", "女"] } }` 数值类型规则： `"labelRangeRules": { "value": { "minValue": 1, "maxValue": 5 } }`

请求样例

--header 'X-Tenant: 1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "manual22",
    "labelEntityType": "baseid",
    "conf": {
        "manualProperty": {
            "dataModelId": 374,
            "idType":"XXX"
        }
    },
    "appId": 1,
    "descr": "",
    "dataTypeName": "string",
    "labelRangeRules": {
        "value": {
            "enumValue": ["男", "女"]
        }
    }
}'

响应参数

名称	数据类型	描述
labelId	int	上传文件id

响应样例

{
  "code": 0, 
  "data": {
    "labelId": 42
  }, 
  "msg": "\u6210\u529f"
}

15. 标签列表高级查询

生效版本	1.20
功能描述	根据项目id获取项目下标签列表，该接口可替换接口【获取所有标签列表，包含各个标签的取值】和【获取人工标签列表】
接口模块	LabelOpenApiApi
接口名称	PostLabels
请求类型	POST
权限校验	有模块和资源权限校验

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	Long	是	项目id

query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-07-03
subjectId	Int	否
type	String	否

Body

名称	数据类型	是否必选	描述
ids	list	否	标签id列表
labelTypes	listlist	否	标签类型列表
subjectIds	list	否	主体id列表
domainIds	list	否	分类id列表
domainNames	list	否	分类名称列表
statuses	list	否	状态列表
computeTypes	list	否	计算类型列表
owners	list	否	标签owner列表
createTime	string	否	创建时间
frequencies	list	否	标签频率列表
syncTypes	list	否	标签调度类型列表
latestRunDate	string	否	最近运行日期
fieldMapIdList	list	否	导入字段id列表

// 查询过滤条件
{
  "ids": [0],
  "labelTypes": ["string"],
  "subjectIds": [0],
  "domainIds": [0],
  "domainNames": ["string"],
  "statuses": [0],
  "computeTypes": ["string"],
  "owners": ["string"],
  "createTime": "string",
  "frequencies": ["string"],
  "syncTypes": [0],
  "latestRunDate": "xxxx-xx-xx",
  "fieldMapIdList": [1]                 // 属性字段id，可通过获取数据源字段列表接口获取
}

请求样例

curl --location --request POST '10.0.0.16:31025/profile_platform/openApi/v2/cdpMeta/labelSystem/label/list' --header 'Authorization: Basic aW5uZXI6NTExODRjNTYtZGZmYy00YTdhLWIzMjctOTI3M2ZkODI5NTk5' --header 'X-User: admin' --header 'X-Tenant: 1' --header 'Content-Type: application/json'

响应参数

标签元信息列表API.xlsx

12.10KB

响应样例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "id":4,
            "name":"autotest_quanliang03181231",
            "orgId":1,
            "projectId":1,
            "descr":"",
            "dataSecurityLevel":null,
            "labelType":"rule",
            "dataTypeName":"string",
            "domainId":-2,
            "domainName": "",     // 生效版本 1.20
            "position":3,
            "entityId":1,
            "entityType":"baseid",
            "computeType":"offline",
            "isMautag":0,
            "syncParams":{
                "scheduleConf":{
                    "frequency":"d",
                    "scheduleTime":"02:00:00"
                },
                "syncType":1
            },
            "conf":{
                "layers":[
                    {
                        "filter":{
                            "operator":"And",
                            "filters":[
                                {
                                    "operator":"And",
                                    "filters":[
                                        {
                                            "operator":"=",
                                            "tagId":3,
                                            "value":0
                                        }
                                    ]
                                }
                            ]
                        },
                        "name":"标签值1"
                    }
                ]
            },
            "taskId":100000018,
            "dimMetId":282,
            "labelRangeRules":null,
            "status":0,
            "createApiTask":false,
            "realtimeTaskId":null,
            "realtimeStatus":null,
            "owner":"admin",
            "createTime":"2023-03-18 12:42:47",
            "updater":"admin",
            "updateTime":"2023-03-18 12:42:50",
            "abiDimMetId":0,
            "lastSuccessTaskInstanceId":1192,
            "latestRunDate":"2023-04-25",
# "userNum":5124,
            "values":null
        }
    ]
}

16. 获取某个标签的枚举值 v2.0

生效版本	1.20
功能描述	获取标签取值（最新导入的标签结果，支持标签类型：bigint, array_bigint, double, array_double, date, array_date, datetime, array_datetime, string, array_string），该接口可替换接口【获取某个标签的取值】
接口模块	LabelOpenApiApi
接口名称	GetLabelValues
请求类型	GET
权限校验	有资源权限校验

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-07-03

Body

名称	数据类型	是否必选	描述
labelId	Int	是	标签id

响应示例

// 枚举型标签
{
    "data":[
        "杭州",
        "上海",
        "北京"
    ],
    "code":0
}

{ // 无法确定取值标签
  "data": [],
  "code": 0
}

17. 添加或者修改某个用户身上的人工标签 v2.0

基本信息

生效版本	1.20
功能描述	添加或者修改某个用户身上的人工标签，该接口可替换接口【添加或者修改某个用户身上的人工标签】和【添加或者修改某个用户身上的实时标签】
接口模块	LabelOpenApiApi
接口名称	UpdateRealtimeTagData
请求类型	POST
权限校验	有资源权限校验

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-07-03

Body

名称	数据类型	是否必选	描述
idFilter	Object	是	修改的对象，type表示id的类型。
newTagValues	Object	是	更新哪些标签

请求样例

curl --location --request POST 'http://10.248.134.123:31025/profile_platform/openApi/v2/cdpMeta/labelSystem/profiles/manualTags' \
--header 'X-BDPP-Id: BDPPcd0254a3f1e45395a5f615472c2c8988' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBJZCI6IkJEUFBjZDAyNTRhM2YxZTQ1Mzk1YTVmNjE1NDcyYzJjODk4OCIsImV4cGlyZXMiOjE2NjczNjYyNDk2NzF9.e36cuJQI4X_cgxSZz8_ttdzWrQ2v5gyWJUfxxMK5T88' \
--header 'Content-Type: application/json' \
--data '{
  "idFilter": {
    "id": "1111111111",
    "type": "baseid"
  },
  "newTagValues": [
    {
      "tagId": 15,
      "value": ["男","女"] 
    },
   {
      "tagId": 16,
      "value": 123
    },
   {
      "tagId": 17,
      "value": 12.13 
    },
   {
      "tagId": 18, 
      "value": "abc"
    }
  ]
}'

响应样例

正确

{
  "data": "更新人工标签成功",
  "code": 0
}

18. 删除某个用户身上的人工标签 v2.0

基本信息

生效版本	1.20
功能描述	删除某个用户身上的人工标签，该接口可替换接口【删除某个用户身上的人工标签】
接口模块	LabelOpenApiApi
接口名称	DeleteRealtimeTagData
请求类型	DELETE
权限校验	有资源权限校验

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-07-03

Body

名称	数据类型	是否必选	描述
tagId	Int	是	标签id
baseId	Int	是	baseid

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

请求样例

curl --location --request DELETE 'http://10.248.134.123:31025/profile_platform/openApi/v2/cdpMeta/labelSystem/profiles/manualTags/1?tagId=1' \
--header 'X-BDPP-Id: BDPP5446c1ed6f6030a2e07746a1775297e9' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBJZCI6IkJEUFA1NDQ2YzFlZDZmNjAzMGEyZTA3NzQ2YTE3NzUyOTdlOSIsImV4cGlyZXMiOjE2NjczNjY3NjMzNTJ9.vuCxyttyh6jMPy6tiPznEtoaw9SQSj_IxOXq9Y7u8f8'

响应样例

正确

{
  "data": "删除人工标签成功",
  "code": 0
}

19. 资产价值评估报表

基本信息

生效版本	1.20.2（仅私部cdp）
功能描述	拉取资产价值评估报表
接口模块	AssetApi
接口名称	GetResourceTable
请求类型	POST

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-08-08

Body

名称	数据类型	是否必选	描述
pageNum	Int	是	页码
pageSize	IntInt	是	页大小
resourceType	string	是	资产类型 label,segment,observer,meta 标签，分群，分析，数据源
startDate	string	否	开始时间
endDate	string	否	结束时间

Header

名称	数据类型	是否必选	描述
X-Tenant	Int	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

请求样例

curl --location 'https://e0-0-93cdp.datarangers-onpremise.volces.com/open_platform/openapi?ApiVersion=2023-08-08&ApiAction=GetResourceTable' \
--header 'AccessKey: BDPP5fb3c9c21f81b1d467ef379e633bd970' \
--header 'SecretKey: 43302dd620f85dd544b5fac8488be7b8' \
--header 'Region: cn' \
--header 'ServiceName: openplatform' \
--header 'X-Tenant: 1' \
--header 'Content-Type: application/json' \
--data '{
    "endDate":"2023-07-20",
    "pageNum": 1,
    "pageSize": 20,
    "startDate": "2023-06-01",
    "resourceType": "label",
    "isCurrentProject": true
    }'

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息
data	Page	返回资产价值报表

Page

名称	数据类型	描述
pageNum	int	页码
pageSize	int	页大小
total	int	总条数
data	Table	资产价值报表

Table

名称	数据类型	描述
headers	List	报表头
rows	List<List<String	Number>>	报表行项目(string,or number 类型）

响应样例

正确

{
    "code": 0,
    "msg": "成功",
    "data": {
        "pageNum": 1,
        "pageSize": 20,
        "total": 10,
        "table": {
            "headers": [
                "资产ID",
                "资产名称",
                "资产类型",
                "数值类型",
                "引用总数",
                "查询总数",
                "调用总数",
                "最近30天引用次数",
                "最近30天查询次数",
                "最近30天调用次数",
                "最近一次引用距今天数",
                "最近一次查询距今天数"
            ],
            "rows": [
                [
                    2,
                    "主体1_全量",
                    "全量标签",
                    "整数型",
                    26,
                    592,
                    932,
                    23,
                    509,
                    654,
                    17,
                    0
                ],
                [
                    11,
                    "实时规则123",
                    "规则标签",
                    "文本型",
                    1,
                    174,
                    4,
                    1,
                    132,
                    5,
                    25,
                    4
                ],
                [
                    168,
                    "date",
                    "人工录入标签",
                    "日期型",
                    1,
                    15,
                    0,
                    1,
                    16,
                    0,
                    2,
                    0
                ],
                [
                    171,
                    "asdfsadf",
                    "规则标签",
                    "文本型",
                    0,
                    10,
                    0,
                    0,
                    10,
                    0,
                    0,
                    4
                ],
                [
                    226,
                    "ttttt",
                    "SQL标签",
                    "整数型",
                    0,
                    15,
                    0,
                    0,
                    15,
                    0,
                    0,
                    3
                ],
                [
                    250,
                    "测试手动状态",
                    "规则标签",
                    "文本型",
                    0,
                    5,
                    0,
                    0,
                    6,
                    0,
                    0,
                    0
                ],
                [
                    265,
                    "测试报错",
                    "规则标签",
                    "文本型",
                    0,
                    13,
                    0,
                    0,
                    13,
                    0,
                    0,
                    1
                ],
                [
                    266,
                    "测试规则标签",
                    "规则标签",
                    "文本型",
                    0,
                    11,
                    0,
                    0,
                    11,
                    0,
                    0,
                    1
                ],
                [
                    267,
                    "测试手动运行标签",
                    "规则标签",
                    "文本型",
                    0,
                    2,
                    0,
                    0,
                    2,
                    0,
                    0,
                    1
                ],
                [
                    268,
                    "测试手动标签创建",
                    "规则标签",
                    "文本型",
                    0,
                    9,
                    0,
                    0,
                    9,
                    0,
                    0,
                    1
                ]
            ]
        }
    },
    "succeed": true
}

20. 获取访问统计-核心指标

基本信息

生效版本	1.20.2（仅私部cdp）
功能描述	获取项目中心-访问统计-核心指标
接口模块	AssetApi
接口名称	GetAccessCoreStatistics
请求类型	POST

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-08-08

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

Body（可选）

名称	数据类型	是否必选	描述
startDate	string	是	业务开始时期（yyyy-MM-dd）
endDate	string	是	业务结束时期（yyyy-MM-dd）
period	string	否	统计周期(默认 day) day，week，month
modules	array	否	选择模块
excludeUsers	array	否	剔除用户ID
groupBy	string	否	查看方式

请求样例

curl --location 'https://e0-0-128cdp.datarangers-onpremise.volces.com/open_platform/openapi?ApiVersion=2023-08-08&ApiAction=GetAccessCoreStatistics' \
--header 'AccessKey: BDPP104c6799bd4cc3a8eaaf0580e41dddd3' \
--header 'SecretKey: 6a8961935ac3ed7a282cf4bdf64a521e' \
--header 'Region: cn' \
--header 'ServiceName: openplatform' \
--header 'X-Tenant: 1' \
--header 'Content-Type: application/json' \
--data '{
    "startDate":"2023-06-20",
    "endDate":"2023-08-20"
    }'

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息
data	List	返回核心统计数据

CoreStatistics

名称	数据类型	描述
indexName	string	指标名称
value	Bigdecimal	指标值

响应样例

正确

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "indexName": "totalUser",
            "value": 8
        },
        {
            "indexName": "newUser",
            "value": 2
        },
        {
            "indexName": "UV",
            "value": 3
        },
        {
            "indexName": "PV",
            "value": 5101
        },
        {
            "indexName": "avgPV",
            "value": 1700.3
        }
    ]
}

21. 获取访问统计-核心指标趋势图

基本信息

生效版本	1.20.2（仅私部cdp）
功能描述	获取项目中心-访问统计-核心指标趋势图
接口模块	AssetApi
接口名称	GetAccessCoreTendencyStatistics
请求类型	POST

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-08-08

Body

名称	数据类型	是否必选	描述
startDate	string	是	业务开始时期（yyyy-MM-dd）
endDate	string	是	业务结束时期（yyyy-MM-dd）
period	string	否	统计周期(默认 day) day，week，month
indexName	string	是	指标值 totalUser(累计账号数） newUser（新增账号数） UV(活跃用户数） PV(总访问数） avgPV(人均访问次数）

请求样例

curl --location 'https://e0-0-128cdp.datarangers-onpremise.volces.com/open_platform/openapi?ApiVersion=2023-08-08&ApiAction=GetAccessCoreTendencyStatistics' \
--header 'AccessKey: BDPP104c6799bd4cc3a8eaaf0580e41dddd3' \
--header 'SecretKey: 6a8961935ac3ed7a282cf4bdf64a521e' \
--header 'Region: cn' \
--header 'ServiceName: openplatform' \
--header 'X-Tenant: 1' \
--header 'Content-Type: application/json' \
--data '{
    "startDate":"2023-06-20",
    "endDate":"2023-08-20",
    "indexName":"totalUser"
    }'

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息
data	List	返回核心统计数据趋势

TendencyStatisticsResp

名称	数据类型	描述
lineName	string	曲线名称
data	List	曲线数据

TendencyStatistics

名称	数据类型	描述
date	string	日期
value	BigDecimal	数值

响应样例

正确

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "lineName": "totalUser",
            "data": [
                {
                    "date": "2023-06-20",
                    "value": 6
                },
                {
                    "date": "2023-06-21",
                    "value": 6
                },
                {
                    "date": "2023-06-22",
                    "value": 6
                },
                {
                    "date": "2023-06-23",
                    "value": 6
                },
                {
                    "date": "2023-06-24",
                    "value": 6
                },
                {
                    "date": "2023-06-25",
                    "value": 6
                },
                {
                    "date": "2023-06-26",
                    "value": 6
                },
                {
                    "date": "2023-06-27",
                    "value": 6
                },
                {
                    "date": "2023-06-28",
                    "value": 6
                },
                {
                    "date": "2023-06-29",
                    "value": 6
                },
                {
                    "date": "2023-06-30",
                    "value": 7
                },
                {
                    "date": "2023-07-01",
                    "value": 7
                },
                {
                    "date": "2023-07-02",
                    "value": 7
                },
                {
                    "date": "2023-07-03",
                    "value": 7
                },
                {
                    "date": "2023-07-04",
                    "value": 7
                },
                {
                    "date": "2023-07-05",
                    "value": 7
                },
                {
                    "date": "2023-07-06",
                    "value": 7
                },
                {
                    "date": "2023-07-07",
                    "value": 7
                },
                {
                    "date": "2023-07-08",
                    "value": 7
                },
                {
                    "date": "2023-07-09",
                    "value": 7
                },
                {
                    "date": "2023-07-10",
                    "value": 7
                },
                {
                    "date": "2023-07-11",
                    "value": 8
                },
                {
                    "date": "2023-07-12",
                    "value": 8
                },
                {
                    "date": "2023-07-13",
                    "value": 8
                },
                {
                    "date": "2023-07-14",
                    "value": 8
                },
                {
                    "date": "2023-07-15",
                    "value": 8
                },
                {
                    "date": "2023-07-16",
                    "value": 8
                },
                {
                    "date": "2023-07-17",
                    "value": 8
                },
                {
                    "date": "2023-07-18",
                    "value": 8
                },
                {
                    "date": "2023-07-19",
                    "value": 8
                },
                {
                    "date": "2023-07-20",
                    "value": 8
                },
                {
                    "date": "2023-07-21",
                    "value": 8
                },
                {
                    "date": "2023-07-22",
                    "value": 8
                },
                {
                    "date": "2023-07-23",
                    "value": 8
                },
                {
                    "date": "2023-07-24",
                    "value": 8
                },
                {
                    "date": "2023-07-25",
                    "value": 8
                },
                {
                    "date": "2023-07-26",
                    "value": 8
                },
                {
                    "date": "2023-07-27",
                    "value": 8
                },
                {
                    "date": "2023-07-28",
                    "value": 8
                },
                {
                    "date": "2023-07-29",
                    "value": 8
                },
                {
                    "date": "2023-07-30",
                    "value": 8
                },
                {
                    "date": "2023-07-31",
                    "value": 8
                },
                {
                    "date": "2023-08-01",
                    "value": 8
                },
                {
                    "date": "2023-08-02",
                    "value": 8
                },
                {
                    "date": "2023-08-03",
                    "value": 8
                },
                {
                    "date": "2023-08-04",
                    "value": 8
                },
                {
                    "date": "2023-08-05",
                    "value": 8
                },
                {
                    "date": "2023-08-06",
                    "value": 8
                },
                {
                    "date": "2023-08-07",
                    "value": 8
                },
                {
                    "date": "2023-08-08",
                    "value": 8
                },
                {
                    "date": "2023-08-09",
                    "value": 8
                },
                {
                    "date": "2023-08-10",
                    "value": 8
                },
                {
                    "date": "2023-08-11",
                    "value": 8
                },
                {
                    "date": "2023-08-12",
                    "value": 8
                },
                {
                    "date": "2023-08-13",
                    "value": 8
                },
                {
                    "date": "2023-08-14",
                    "value": 8
                },
                {
                    "date": "2023-08-15",
                    "value": 8
                },
                {
                    "date": "2023-08-16",
                    "value": 8
                },
                {
                    "date": "2023-08-17",
                    "value": 8
                },
                {
                    "date": "2023-08-18",
                    "value": 8
                },
                {
                    "date": "2023-08-19",
                    "value": 8
                }
            ]
        }
    ]
}

22. 上架标签

基本信息

生效版本	1.21.1（仅私部cdp）
功能描述	上架标签有权限校验
接口模块	LabelApi
接口名称	PublishLabel
请求类型	PUT

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-10-19
id	integer	是	标签ID

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息

23. 下架标签

基本信息

生效版本	1.21.1（仅私部cdp）
功能描述	下架标签有权限校验
接口模块	LabelApi
接口名称	UnPublishLabel
请求类型	PUT

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-10-19
id	integer	是	标签ID

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息

24. 删除标签

基本信息

生效版本	1.21.1（仅私部cdp）
功能描述	删除标签有权限校验
接口模块	LabelApi
接口名称	DeleteLabel
请求类型	DELETE

请求参数

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-10-19
id	integer	是	标签ID

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	Token，以 “Bearer ”开头（注意：Bearer后有空格）

响应参数

名称	数据类型	描述
code	int	返回状态码 0表成功
msg	string	成功 or错误信息

25. 创建标签文件夹

基本信息

生效版本	1.22
功能描述	创建标签文件夹
接口模块	openapi
接口名称（ApiAction）	addLabelDomain
接口版本（ApiVersion）	2024-01-25
请求类型	POST

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

AddLabelDomainEvent

名称	数据类型	是否必选	描述
name	String	是	标签分类名称
subjectId	String	是	主体id
targetNodeId	Number	否	所在父分类id, 为空时默认在根目录

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	Number	接口返回
extraMsg	String	接口返回额外信息

26. 修改标签文件夹

基本信息

生效版本	1.22
功能描述	修改标签文件夹
接口模块	openapi
接口名称（ApiAction）	updateLabelDomain
接口版本（ApiVersion）	2024-01-25
请求类型	PUT

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

UpdateLabelDomainEvent

名称	数据类型	是否必选	描述
id	Number	是	标签分类id
name	String	是	标签分类名称

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	Number	接口返回
extraMsg	String	接口返回额外信息

27. 删除标签文件夹

基本信息

生效版本	1.22
功能描述	删除标签文件夹
接口模块	openapi
接口名称（ApiAction）	daleteLabelDomain
接口版本（ApiVersion）	2024-01-25
请求类型	DELETE

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

DeleteLabelDomainEvent

名称	数据类型	是否必选	描述
id	Number	是	标签分类id

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	Number	接口返回
extraMsg	String	接口返回额外信息

28. 移动标签文件夹

基本信息

生效版本	1.22
功能描述	移动标签文件夹
接口模块	openapi
接口名称（ApiAction）	moveLabelDomain
接口版本（ApiVersion）	2024-01-25
请求类型	POST

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

NodeMoveAction

名称	数据类型	是否必选	描述
id	Number	是	标签分类id
locate	String	否	参考相对位置，相对参考Id对应对象的 Before：上方 After：下方，不传默认最下方
nodeId	Number	否	目标结点ID，操作对象要移动到的目标结点ID，此项为null时表示为根结点
targetId	Number	否	参考对象ID，必须与操作对象同类别，作为移动相对位置的参考系，targetId不指定时默认移动到指定结点队尾

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	Number	接口返回
extraMsg	String	接口返回额外信息

29. 移动标签

基本信息

生效版本	1.22
功能描述	移动标签
接口模块	openapi
接口名称（ApiAction）	moveLabelToDomain
接口版本（ApiVersion）	2024-01-25
请求类型	POST

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

NodeMoveAction

名称	数据类型	是否必选	描述
id	Number	是	ID
locate	String	否	参考相对位置，相对参考Id对应对象的 Before：上方 After：下方，不传默认最下方
nodeId	Number	否	目标结点ID，操作对象要移动到的目标结点ID
targetId	Number	否	参考对象ID，必须与操作对象同类别，作为移动相对位置的参考系，targetId不指定时默认移动到指定结点队尾

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	Number	接口返回
extraMsg	String	接口返回额外信息

30. 查询用户标签和属性V2

基本信息

生效版本	1.22
功能描述	查询用户标签和属性V2,老版本返回数据会两次序列化，此做了接口优化不在做两次序列化
接口模块	openapi
接口名称（ApiAction）	GetUserProfileWithPrivacyV2
接口版本（ApiVersion）	2024-01-25
请求类型	POST

请求体

onlineGetUserProfileRequest

名称	数据类型	是否必选	描述
project	String	是	租户code
profile_request	Object	否	参考 onlineGetUserProfileRequest

响应结果

onlineGetUserProfileRequest

名称	数据类型	描述
code	Number	状态码，0表示正常
tags	Object	标签结果，map结构
message	String	接口返回信息
properties	Object	属性结果，map结构
tagsMapping	Object	标签的结果，key 是标签id, value 是标签的值
illegal_data	Array	不合法的数据
propertiesMapping	Object	属性的结果，key 是属性id, value 是属性的值

最近更新时间：2024.05.21 19:37:29

这个页面对您有帮助吗？

有用

无用