Benutzerattribute abfragen

Ermöglicht Entwickler:innen, Benutzerattribute durch Angabe von Benutzer-IDs oder anonymen Benutzer-IDs abzufragen. Unterstützt Batch-Abfragen (Stapelabfragen) von bis zu 100 Benutzer-IDs oder anonymen Benutzer-IDs pro Anfrage.

Anfragemethode

GET

Anfrage-URL

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

Authentifizierung

Bitte beachten Sie die Übersicht in der API-Referenz.

Anfrage

Beispielanfrage

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Authentifizierung über Authorization: Bearer ${API Key}. Den Token erhalten Sie auf der API Keys-Seite.

Anfrage-Body

Parameter	Typ	Beschreibung	Erforderlich
user_ids	string	Benutzer-IDs, für die Attribute abgefragt werden sollen	Erforderlich, darf nicht zusammen mit anonymous_ids verwendet werden
anonymous_ids	string	Anonyme Benutzer-IDs, für die Attribute abgefragt werden sollen	Erforderlich, darf nicht zusammen mit user_ids verwendet werden

Entweder user_ids oder anonymous_ids müssen angegeben werden. Wenn beide angegeben werden, haben user_ids Vorrang.

Antwort

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

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Parameter	Typ	Beschreibung
user_id	string	Die abgefragte Benutzer-ID
anonymous_id	string	Die abgefragte anonyme Benutzer-ID
property_values	Liste	Liste der Benutzerattribute und deren Werte für die user_id
property_name	string	Name des Benutzerattributs
value	object	Wert des Benutzerattributs

Fehlerantwort

Parameter	Typ	Beschreibung
code	int	Fehlercode
message	string	Fehlermeldung

Statuscodes

Statuscode	Beschreibung
200	Erfolg
400	Ungültige Parameter
401	Nicht autorisiert
403	Verboten
500	Serverfehler
503	Benutzer-ID nicht gefunden
504	Anonyme Benutzer-ID nicht gefunden