Verify User Segment

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

Verify whether a user is in a specified segment in the Data Profile service.

API address

GET: /v1.0/user-profile/group/user/check

Request parameter

Parameter name Type IN Required Description
params String query true The information about a specified segment.

Description of params

Parameter name Type IN Required Description
bizType String true The user domain.
groupId Integer true The ID of a specified segment.
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.

Return parameter

Parameter name Type Description
result Object The returned result.

Description of result

Parameter name Type Description
resultDO Boolean
  • true: The user is in the specified segment.
  • false: The user is not in the specified segment.
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/group/user/check?params={"bizType":4xxx22,"groupId":9xx,"searchValue":"guxxxxx0153915","searchType":0}

Return example

{ "result": { "resultDO": true, "success": true }, "t": 1628236525772, "success": true }

Error code

For more information, see error code.