Query User Attributes

Allows developers to query user attributes by specifying user IDs or anonymous user IDs. Supports batch queries of up to 100 user IDs or anonymous user IDs per request.

Request Method

GET

Request URL

https://api-${endpoint}.gptbots.ai/v2/user-property/query

Authentication

Please refer to Overview in API Reference.

Request

Request Example

curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query' \ -H 'Authorization: Bearer ${token}' \ -d '{ "user_ids": [ "example_user_id_1", "example_user_id_2" ], "anonymous_ids": [ "example_anonymous_id_1", "example_anonymous_id_2" ] }'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query'  \
-H 'Authorization: Bearer ${token}' \
-d '{
      "user_ids": [
        "example_user_id_1",
        "example_user_id_2"
      ],
      "anonymous_ids": [
        "example_anonymous_id_1",
        "example_anonymous_id_2"
      ]
}'

This code block in the floating window

Request Headers

Field	Type	Description
Authorization	Bearer ${API Key}	Authentication using Authorization: Bearer ${API Key}. Obtain the token from the API Keys page.

Request Body

Parameter	Type	Description	Required
user_ids	string	User IDs to query attributes for	Required, mutually exclusive with anonymous_ids
anonymous_ids	string	Anonymous user IDs to query attributes for	Required, mutually exclusive with user_ids

Either user_ids or anonymous_ids must be provided. If both are provided, user_ids will take precedence.

Response

Response Body

{ { "user_id": "example_user_id_1", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] }, { "anonymous_id": "example_anonymous_id_2", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] } }

                      
                      {
  {
    "user_id": "example_user_id_1",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  },
  {
    "anonymous_id": "example_anonymous_id_2",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  }
}

This code block in the floating window

Successful Response

Parameter	Type	Description
user_id	string	The queried user ID
anonymous_id	string	The queried anonymous user ID
property_values	list	List of user attributes and their values for the user_id
property_name	string	Name of the user attribute
value	object	Value of the user attribute

Error Response

Parameter	Type	Description
code	int	Error code
message	string	Error message

Status Codes

Status Code	Description
200	Success
400	Invalid Parameters
401	Unauthorized
403	Forbidden
500	Server Error
503	User ID Not Found
504	Anonymous User ID Not Found