Interroger les attributs utilisateur

Permet aux développeurs d'interroger les attributs utilisateur en spécifiant des identifiants utilisateur ou des identifiants utilisateur anonymes. Prend en charge les requêtes groupées jusqu'à 100 identifiants utilisateur ou identifiants anonymes par requête.

Méthode de requête

GET

URL de la requête

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

Authentification

Veuillez consulter la section Aperçu dans la référence API.

Requête

Exemple de requête

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

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Authentification via Authorization: Bearer ${API Key}. Obtenez votre clé API depuis la page des clés API.

Corps de la requête

Paramètre	Type	Description	Obligatoire
user_ids	string	Identifiants utilisateur à interroger	Obligatoire, exclusif avec anonymous_ids
anonymous_ids	string	Identifiants utilisateur anonymes à interroger	Obligatoire, exclusif avec user_ids

Vous devez fournir soit user_ids, soit anonymous_ids. Si les deux sont fournis, user_ids sera prioritaire.

Réponse

Corps de la réponse

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

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Paramètre	Type	Description
user_id	string	Identifiant utilisateur interrogé
anonymous_id	string	Identifiant utilisateur anonyme interrogé
property_values	list	Liste des attributs utilisateur et leurs valeurs pour le user_id
property_name	string	Nom de l'attribut utilisateur
value	object	Valeur de l'attribut utilisateur

Réponse d'erreur

Paramètre	Type	Description
code	int	Code d'erreur
message	string	Message d'erreur

Codes d'état

Code d'état	Description
200	Succès
400	Paramètres invalides
401	Non autorisé
403	Interdit
500	Erreur serveur
503	Identifiant utilisateur introuvable
504	Identifiant utilisateur anonyme introuvable