Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ User Behavior Analysis (Invitational Test)
Updated on 2025-11-17 GMT+08:00
View PDF

User Behavior Analysis (Invitational Test)

Function

User Behavior Analysis: The function of this API is in the invitation test phase and will be gradually opened with the OBT.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/datamap/uba

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

instance

Yes

String

Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

event

Yes

String

Pointer to the event name.

params

Yes

Array of EventParam objects

Event parameter.
Table 4 EventParam

Parameter

Mandatory

Type

Description

guid

No

String

Asset GUID.

type_name

No

String

Asset type.

model_id

No

String

Module ID.

property_name

No

String

Parameter name.

property_value

No

String

Parameter value,

query

No

String

Enter a value in the search box.

filter

No

DataMapFilterCriteria object

Query filter criteria.

guid_list

No

Array of strings

GUID list.

trace_id

No

String

Trace ID.

source_trace_id

No

String

Source tracing ID

metadata_type_name

No

String

Asset type.

super_type_names

No

String

Asset parent type.

workspace_ids

No

Array of strings

Workspace list
Table 5 DataMapFilterCriteria

Parameter

Mandatory

Type

Description

attribute

No

String

Filter attribute dimension.

operator

No

String

Operation identifier.

value

No

Array of strings

Attribute filtering value, which varies depending on the attribute. If the attribute is base.DataAsset.sourceType, the value can be ["dws", "hive"].

condition

No

String

Condition combination rule.

criterion

No

Array of DataMapFilterCriteria objects

Condition criterion

Response Parameters

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "event" : "catalog_search_click_entity",
  "params" : [ {
    "query" : "",
    "guid" : "8050ccb6-14bc-48ea-8984-7dc661e9a2a9"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.
Parent Topic: Data Map