Kundenverhalten und Nutzer-Events

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

// api.RequestProcessingStatus

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "api_key_name" : "(required, string) Customer-defined name of the API key used for the request",
    "api_key_prefix" : "(required, string) First 8 characters of the API key used for the request",
    "app_group_id" : "(optional, string) API ID of the workspace the request was made to",
    "final_completion_time" : "(required, string) ISO 8601 UTC timestamp at which Braze finished processing the request",
    "group_id" : "(optional, string) Request group ID supplied with the request, present only when the request was accepted for group tracking",
    "request_id" : "(required, string) ID of the API request, from the X-Request-ID header supplied by the edge",
    "request_received_time" : "(required, string) ISO 8601 UTC timestamp at which Braze accepted the request",
    "status" : "(required, string) Processing status of the request"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// dataobjects.DoRelType

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "cardinality" : "(optional, string) Cardinality of the relationship: one_to_one, one_to_many, or many_to_many",
    "created_at" : "(optional, int) UNIX timestamp at which the relationship type was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the relationship type was deleted",
    "forward_name" : "(optional, string) Label for the relationship when viewed from the source object, for example Subaccount",
    "forward_name_plural" : "(optional, string) Plural label for the relationship when viewed from the source object",
    "from_type_name" : "(optional, string) Type name of the from side",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "reverse_name" : "(optional, string) Label for the relationship when viewed from the target object, for example Parent Account",
    "reverse_name_plural" : "(optional, string) Plural label for the relationship when viewed from the target object",
    "to_type_name" : "(optional, string) Type name of the to side",
    "updated_at" : "(optional, int) UNIX timestamp at which the relationship type was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// dataobjects.DoRelTypeField

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "created_at" : "(optional, int) UNIX timestamp at which the field was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the field was deleted",
    "display_label" : "(optional, string) Display label of the field",
    "format" : "(optional, string) JSON Schema format of the field, for example date-time",
    "from_type_name" : "(optional, string) Type name of the from side",
    "json_type" : "(optional, string) JSON type of the field. One of string, number, integer, or boolean",
    "name" : "(required, string) Name of the field",
    "position" : "(optional, int) Sort position of the field",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "required" : "(optional, boolean) Whether the field is required",
    "to_type_name" : "(optional, string) Type name of the to side",
    "updated_at" : "(optional, int) UNIX timestamp at which the field was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

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

// dataobjects.Object

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "attributes" : "(optional, string) Name-keyed attribute JSON. Keys are field names.",
    "created_at" : "(optional, int) UNIX timestamp at which the object was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the object was deleted",
    "display_name" : "(optional, string) Display name of the object",
    "do_type_name" : "(required, string) The name of the type, for example account",
    "object_id" : "(required, string) Customer-assigned identifier of the data object",
    "updated_at" : "(optional, int) UNIX timestamp at which the object was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// dataobjects.RelDoToDo

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "attributes" : "(optional, string) Name-keyed attribute JSON. Keys are field names.",
    "created_at" : "(optional, int) UNIX timestamp at which the relationship was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the relationship was deleted",
    "from_object_id" : "(optional, string) Customer-assigned identifier of the from object",
    "from_type_name" : "(optional, string) Type name of the from object",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "to_object_id" : "(optional, string) Customer-assigned identifier of the to object",
    "to_type_name" : "(optional, string) Type name of the to object",
    "updated_at" : "(optional, int) UNIX timestamp at which the relationship was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// dataobjects.RelUserToDo

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "attributes" : "(optional, string) Name-keyed attribute JSON. Keys are field names.",
    "created_at" : "(optional, int) UNIX timestamp at which the relationship was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the relationship was deleted",
    "do_type_name" : "(required, string) The name of the type, for example account",
    "object_id" : "(required, string) Customer-assigned identifier of the data object",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "updated_at" : "(optional, int) UNIX timestamp at which the relationship was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : {
    "external_user_id" : "(optional, string) [PII] External ID of the related user",
    "user_id" : "(required, string) [PII] Braze user ID of the related user"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// dataobjects.Type

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "created_at" : "(optional, int) UNIX timestamp at which the type was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the type was deleted",
    "description" : "(optional, string) A description of the type",
    "display_name_plural" : "(optional, string) Plural display name",
    "display_name_singular" : "(optional, string) Singular display name",
    "icon" : "(optional, string) URL of the icon for the type",
    "is_built_in" : "(required, boolean) True for a type created from a built-in template",
    "type_name" : "(optional, string) API type name, for example account",
    "updated_at" : "(optional, int) UNIX timestamp at which the type was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// dataobjects.TypeField

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "created_at" : "(optional, int) UNIX timestamp at which the field was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the field was deleted",
    "display_label" : "(optional, string) Display label of the field",
    "do_type_name" : "(required, string) The name of the type, for example account",
    "format" : "(optional, string) JSON Schema format of the field, for example date-time",
    "json_type" : "(optional, string) JSON type of the field. One of string, number, integer, or boolean",
    "name" : "(required, string) Name of the field",
    "position" : "(optional, int) Sort position of the field",
    "required" : "(optional, boolean) Whether the field is required",
    "updated_at" : "(optional, int) UNIX timestamp at which the field was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// dataobjects.UserRelType

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "cardinality" : "(optional, string) Cardinality of the relationship: one_to_one, one_to_many, or many_to_many",
    "created_at" : "(optional, int) UNIX timestamp at which the relationship type was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the relationship type was deleted",
    "do_type_name" : "(required, string) The name of the type, for example account",
    "forward_name" : "(optional, string) Label for the relationship when viewed from the object, for example \"user\"",
    "forward_name_plural" : "(optional, string) Plural label for the relationship when viewed from the object",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "reverse_name" : "(optional, string) Label for the relationship when viewed from the user, for example \"account\"",
    "reverse_name_plural" : "(optional, string) Plural label for the relationship when viewed from the user",
    "updated_at" : "(optional, int) UNIX timestamp at which the relationship type was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// dataobjects.UserRelTypeField

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this create, update, or delete event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the workspace this record belongs to",
    "created_at" : "(optional, int) UNIX timestamp at which the field was created",
    "deleted" : "(optional, boolean) True when the record was deleted",
    "deleted_at" : "(optional, int) UNIX timestamp at which the field was deleted",
    "display_label" : "(optional, string) Display label of the field",
    "do_type_name" : "(required, string) The name of the type, for example account",
    "format" : "(optional, string) JSON Schema format of the field, for example date-time",
    "json_type" : "(optional, string) JSON type of the field. One of string, number, integer, or boolean",
    "name" : "(required, string) Name of the field",
    "position" : "(optional, int) Sort position of the field",
    "rel_kind" : "(optional, string) Stable name of the relationship kind",
    "required" : "(optional, boolean) Whether the field is required",
    "updated_at" : "(optional, int) UNIX timestamp at which the field was updated"
  },
  "time" : "(required, int) UNIX timestamp at which the record was created, modified or deleted",
  "user" : { }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// users.behaviors.CustomEvent

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "ad_id" : "(optional, string) [PII] Advertising identifier",
    "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
    "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "device_model" : "(optional, string) Model of the device",
    "name" : "(required, string) Name of the custom event",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device",
    "received_at_ms" : "(optional, long) UNIX timestamp, in milliseconds, at which Braze received the request that contained this event. For some batched API requests, this is when the batch was queued, which can be a few seconds later."
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "timezone" : "(optional, string) Time zone of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

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

// users.behaviors.InstallAttribution

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "source" : "(optional, string) The source of the attribution"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// users.behaviors.Location

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "ad_id" : "(optional, string) [PII] Advertising identifier",
    "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
    "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
    "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location",
    "altitude" : "(optional, float) [PII] Altitude of recorded location",
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "device_model" : "(optional, string) Model of the device",
    "latitude" : "(required, float) [PII] Latitude of recorded location",
    "ll_accuracy" : "(optional, float) Accuracy of the latitude and longitude of recorded location",
    "longitude" : "(required, float) [PII] Longitude of recorded location",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// users.behaviors.Purchase

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "ad_id" : "(optional, string) [PII] Advertising identifier",
    "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
    "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "currency" : "(required, string) Currency of the purchase",
    "device_model" : "(optional, string) Model of the device",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device",
    "price" : "(required, float) Price of the purchase",
    "product_id" : "(required, string) ID of the product purchased"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// users.behaviors.app.FirstSession

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "device_model" : "(optional, string) Model of the device",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device",
    "session_id" : "(optional, string) UUID of the session"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "timezone" : "(optional, string) Time zone of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// users.behaviors.app.SessionEnd

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "device_model" : "(optional, string) Model of the device",
    "duration" : "(optional, float) Duration of the session in seconds",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device",
    "session_id" : "(optional, string) UUID of the session"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}

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

// users.behaviors.app.SessionStart

{
  "event_type" : "(required, string) The name of the event type",
  "id" : "(required, string) Globally unique ID for this event",
  "properties" : {
    "app_group_id" : "(optional, string) API ID of the app group this user belongs to",
    "app_id" : "(optional, string) API ID of the app on which this event occurred",
    "device_model" : "(optional, string) Model of the device",
    "os_version" : "(optional, string) Version of the operating system of the device",
    "platform" : "(optional, string) Platform of the device",
    "session_id" : "(optional, string) UUID of the session"
  },
  "time" : "(required, int) UNIX timestamp at which the event happened",
  "user" : {
    "device_id" : "(optional, string) ID of the device on which the event occurred",
    "external_user_id" : "(optional, string) [PII] External ID of the user",
    "user_id" : "(required, string) [PII] Braze user ID of the user who performed this event"
  }
}