Consultar atributos de usuario

Permite a los desarrolladores consultar atributos de usuario especificando IDs de usuario o IDs de usuario anónimo. Admite consultas por lotes de hasta 100 IDs de usuario o IDs de usuario anónimo por solicitud.

Método de solicitud

GET

URL de solicitud

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

Autenticación

Se recomienda consultar Visión general en la referencia de la API.

Solicitud

Ejemplo de solicitud

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"
      ]
}'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Autenticación mediante `Authorization: Bearer ${API Key}`. El token se obtiene en la página «API Keys».

Cuerpo de la solicitud

Parámetro	Tipo	Descripción	Obligatorio
user_ids	string	IDs de usuario para los que se consultan los atributos	Obligatorio; mutuamente excluyente con anonymous_ids
anonymous_ids	string	IDs de usuario anónimo para los que se consultan los atributos	Obligatorio; mutuamente excluyente con user_ids

Se debe proporcionar user_ids o anonymous_ids. Si se proporcionan ambos, user_ids tendrá prioridad.

Respuesta

Cuerpo de la respuesta

[ { "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"
      }
    ]
  }
]

Este bloque de código en una ventana flotante

Respuesta correcta

Parámetro	Tipo	Descripción
user_id	string	ID de usuario consultado
anonymous_id	string	ID de usuario anónimo consultado
property_values	list	Lista de atributos de usuario y sus valores para el user_id
property_name	string	Nombre del atributo de usuario
value	string	Valor del atributo de usuario

Respuesta de error

Parámetro	Tipo	Descripción
code	int	Código de error
message	string	Mensaje de error

Códigos de estado

Código de estado	Descripción
200	Correcto
400	Parámetros no válidos
401	No autorizado
403	Prohibido
500	Error del servidor
503	No se encontró el ID de usuario
504	No se encontró el ID de usuario anónimo