Nutzer:innen-Beziehungen auflisten

Verwenden Sie diesen Endpunkt, um Nutzer:innen aufzulisten, die mit einem Data Object verknüpft sind.

Wichtig

Data Objects ist allgemein verfügbar, aber Ihr Workspace muss für Accounts bereitgestellt sein, bevor Sie diesen Endpunkt verwenden können. Um die Bereitstellung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.user_relationships.read.

Rate-Limit

Dieser Endpunkt gehört zum Data-Objects-Lese-Bucket mit einem Standardlimit von 1000 Anfragen pro Minute.

Pfadparameter

Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/objects/{type_name}/{object_id}/user_relationships.

Abfrageparameter

Die folgende Tabelle listet und beschreibt die Abfrageparameter für den Endpunkt /data_objects/objects/{type_name}/{object_id}/user_relationships.

Beispielanfrage

Dieser Abschnitt enthält eine Beispiel-Payload mit Parametern und eine Beispiel-cURL-Anfrage.

Beispiel-Anfrage-Payload

Verwenden Sie dieses JSON-Objekt als Referenz für Anfrageparameter.

1
2
3
4
5
6
7

{
  "type_name": "account",
  "object_id": "acct-123",
  "rel_kind": "account_user",
  "limit": 100,
  "offset": 0
}

Beispiel-cURL-Anfrage

Dieses Beispiel listet die Nutzer:innen auf, die über die Beziehung account_user mit acct-123 verknüpft sind.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/user_relationships?rel_kind=account_user&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Antwort

Dieser Abschnitt enthält eine Beispielantwort bei Erfolg und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 könnte den folgenden Antwortkörper zurückgeben.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "items": [
    {
      "type_name": "account",
      "object_id": "acct-123",
      "rel_kind": "account_user",
      "user": { "braze_id": "507f1f77bcf86cd799439011" },
      "attributes": { "role": "admin" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

Die user-Payload enthält nur braze_id.

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder einer erfolgreichen Antwort.

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt und deren Behebung auf.