Get User Label Details

Last Updated on : 2023-06-20 12:34:13download

Get label details of a user in the Data Profile service.

API address

GET: /v1.0/user-profile/user/tags

Request parameter

Parameter name Type IN Required Description
params String query true JSON

Description of params

Parameter name Type IN Required Description
bizType String true The user domain.
tags Integer false Filter the specified type of labels. For more information about the input parameters of the label field, see User label field at the end of this topic.
searchType Integer false Search type:
  • 0: Search by account.
  • 1: Search by email address.
  • 2: Search by mobile phone number.
  • 3: Search by UID.
searchValue String true The keywords. It is used with searchType.
isEn String false Determine whether the content of the returned label details is in English. Default value: Chinese.
  • true: The content is in English.
  • false: The content is in Chinese.

Return parameter

Parameter name Type Description
result OpenApiResult The returned result.

Description of result

Parameter name Type Description
resultDO Object The specific label value of a user.
error_code String The error code.
error_msg String The error message.
success Boolean Indicates whether the operation is successful.

Request example

GET: /v1.0/user-profile/user/tags?params={"bizType":12xx27 ,"searchValue":"ay162xxxxxxxxJmfe","tags":["username","user_level","city_cn"],"searchType":3,"isEn":false}

Return example

{ "result": { "resultDO": { "city_cn": "Hangzhou", "user_level": "Elementary user", "username": "" }, "success": true }, "t": 1628236440462, "success": true }

Error code

For more information, see error code.