Logging Standard Events

Published on Feb 25, 2025

Prev Next

Post

/event/standard

This endpoint is used to log standard events i.e. Commerce, Content, User Lifecycle.

Body parameters

Collapse all

object

branch_key

string Required

The Branch Key of the originating app obtained in your Account Settings

Examplekey_live_xxxx

name

string Required

The name of the event to log. Can be one of the following depending on which type of report you are running. Here are the list of possible combinations:

Commerce:
- ADD_TO_CART
- ADD_TO_WISHLIST
- VIEW_CART
- INITIATE_PURCHASE
- ADD_PAYMENT_INFO
- CLICK_AD
- PURCHASE
- SPEND_CREDITS
- VIEW_AD
Content:
- SEARCH
- VIEW_ITEM
- VIEW_ITEMS
- RATE
- SHARE
- INITIATE_STREAM
- COMPLETE_STREAM
User Lifecycle:
- COMPLETE_REGISTRATION
- COMPLETE_TUTORIAL
- ACHIEVE_LEVEL
- UNLOCK_ACHIEVEMENT
- INVITE
- LOGIN
- START_TRIAL
- SUBSCRIBE

Valid values[ "ADD_TO_CART", "ADD_TO_WISHLIST", "CLICK_AD", "VIEW_CART", "INITIATE_PURCHASE", "ADD_PAYMENT_INFO", "PURCHASE", "SPEND_CREDITS", "SEARCH", "VIEW_ITEM", "VIEW_ITEMS", "RATE", "SHARE" ]

ExamplePURCHASE

customer_event_alias

string

The event alias as defined by you; used in addition to the event name defined above.

Examplemy custom alias

user_data

object (user_data_standard) Required

string

One of the following operating system e.g. Android, iOS,MAC_OS,LINUX,WINDOWS etc.

ExampleAndroid

os_version

string

The version of the operating system.

Example12.4.0

environment

string

usually FULL_APP

ExampleFULL_APP

aaid

string

The Android/Google advertising ID.

Exampleabcdabcd-0123-0123-00f0-000000000000

android_id

string

Android hardware ID

Examplea12300000000

idfa

string

iOS advertising ID

idfv

string

iOS vendor ID

limit_ad_tracking

boolean

true if the partner has opted to not be tracked by advertisers

ExampleFalse

user_agent

string

The user agent of the browser or app where the event occurred. Usually associated with a webview.

ExampleMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko)

browser_fingerprint_id

string

Branch internal-only field for tracking browsers.

Example00000000

http_origin

string

The current page url where Web SDK logged web session start.

Examplehttp_origin

http_referrer

string

The referral url that led to the current page where Web SDK logged web session start.

developer_identity

string

The developer-specified identity for a user.

Exampleuser123

country

string

The country code of the user, usually based on device settings or user agent string.

ExampleUS

language

string

The language code of the user, usually based on device settings or user agent string.

Exampleen

string

The ip address for the device where the event occurred

Example000.000.0.0

local_ip

string

Android only - local ip of the device

Example000.000.0.0

brand

string

The brand of the device

ExampleLGE

randomized_device_token

string

Branch internal-only field for tracking devices.

Example00000000

app_version

string

The app version downloaded by the user.

Example1.0.0

model

string

The model of the device.

ExampleNexus 5X

screen_dpi

integer

The screen's DPI.

Example420

screen_height

integer

The screen's height.

Example1794

screen_width

integer

The screen's width.

Example1080

dma_eea

boolean

Whether European regulations, including the DMA, apply to this user and conversion. Required if EU regulations apply to this user.

ExampleTrue

dma_ad_personalization

boolean

Whether end user has granted or denied ads personalization consent. Required if dma_eea is set to true (i.e., EU regulations apply to this user).

ExampleTrue

dma_ad_user_data

boolean

Whether end user has granted or denied consent for 3P transmission of user level data for ads. Required if dma_eea is set to true (i.e., EU regulations apply to this user).

ExampleTrue

custom_data

object

event_data

object (event_data_standard)

content_items

Array of object (content_items_standard)

object

$content_schema

string

Category / Schema for a piece of content.

Valid values[ "COMMERCE_AUCTION", "COMMERCE_BUSINESS", "COMMERCE_OTHER", "COMMERCE_PRODUCT", "COMMERCE_RESTAURANT", "COMMERCE_SERVICE", "COMMERCE_TRAVEL_FLIGHT", "COMMERCE_TRAVEL_HOTEL", "COMMERCE_TRAVEL_OTHER", "GAME_STATE", "MEDIA_IMAGE", "MEDIA_MIXED", "MEDIA_MUSIC", "MEDIA_OTHER", "MEDIA_VIDEO", "OTHER", "TEXT_ARTICLE", "TEXT_BLOG", "TEXT_OTHER", "TEXT_RECIPE", "TEXT_REVIEW", "TEXT_SEARCH_RESULTS", "TEXT_STORY", "TEXT_TECHNICAL_DOC" ]

ExampleCOMMERCE_PRODUCT

$og_title

string

Commerce and Content Reports only. The title (for the individual content item).

ExampleMy Content Title

$og_image_url

string

Commerce and Content Reports only. The image URL (for the individual content item).

Examplevalid URL

$canonical_identifier

string

Commerce and Content Reports only. Used to allow Branch to unify content/messages for Content Analytics

Exampleitem12345

$publicly_indexable

boolean

Commerce and Content Reports only. true- content can be seen by anyone. false- cannot index for public use

ExampleFalse

$locally_indexable

boolean

Commerce and Content Reports only. true- content can be indexed for local (device) use. false- cannot index for local use

ExampleTrue

$price

string

Commerce and Content Reports only. The price for the product/content.

Example23.2

$quantity

string

Commerce and Content Reports only. The quantity of the item to be ordered (for PURCHASE, ADD_TO_CART, etc).

Example2

$sku

string

Commerce and Content Reports only. The product sku or product ID.

Example1994320302

$product_name

string

Commerce and Content Reports only. The product's name.

Examplemy_product_name1

$product_brand

string

Commerce and Content Reports only. The product's brand.

Examplemy_prod_Brand1

$product_category

string

Commerce and Content Reports only. The product's category, if it's a product

Valid values[ "ANIMALS_AND_PET_SUPPLIES", "APPAREL_AND_ACCESSORIES", "ARTS_AND_ENTERTAINMENT", "BABY_AND_TODDLER", "BUSINESS_AND_INDUSTRIAL", "CAMERAS_AND_OPTICS", "ELECTRONICS", "FOOD_BEVERAGES_AND_TOBACCO", "FURNITURE", "HARDWARE", "HEALTH_AND_BEAUTY", "HOME_AND_GARDEN", "LUGGAGE_AND_BAGS", "MATURE", "MEDIA", "OFFICE_SUPPLIES", "RELIGIOUS_AND_CEREMONIAL", "SOFTWARE", "SPORTING_GOODS", "TOYS_AND_GAMES", "VEHICLES_AND_PARTS" ]

ExampleBABY_AND_TODDLER

$product_variant

string

Commerce and Content Reports only. The product's variant (e.g. XL, red).

Example3T

$rating_average

integer

Commerce and Content Reports only. The average rating of the item.

Example5

$rating_count

string

Commerce and Content Reports only. The number of ratings for the item.

Example5

$rating_max

integer

Commerce and Content Reports only. The maximum possible rating for the item (e.g. 5.0 if 5 stars is highest possible rating).

Example5

$creation_timestamp

integer

Commerce and Content Reports only. The time the content was created.

Example0

$exp_date

integer

Commerce and Content Reports only. The last time after which this content is no longer valid. null / 0 mean no limit. Should rarely be set.

Example0

$keywords

Array of string

Commerce and Content Reports only. keywords

ExampleMy_Keyword1

string

$address_street

string

Commerce and Content Reports only. The street address for a restaurant, business, room (hotel), etc.

ExampleStreet_name1

$address_city

string

Commerce and Content Reports only. The street address for a restaurant, business, room (hotel), etc.

Examplecity1

$address_region

string

Commerce and Content Reports only. The state or region for a restaurant, business, room (hotel), etc.

ExampleRegion1

$address_country

string

Commerce and Content Reports only. The country code for a restaurant, business, room (hotel), etc.

ExampleCountry1

$address_postal_code

string

Commerce and Content Reports only. The postal/zip code for a restaurant, business, room (hotel), etc.

Examplepostal_code

$latitude

number

Commerce and Content Reports only. The latitude for a restaurant, business, room (hotel), etc.

Example12.07

$longitude

number

Commerce and Content Reports only. The longitude for a restaurant, business, room (hotel), etc.

Example-97.5

$image_captions

Array of string

Commerce and Content Reports only. The captions associated with the image.

string

Examplemy_img_caption1

$condition

string

Commerce and Content Reports only. For auctions, whether the item is new, good, acceptable, etc.

Valid values[ "OTHER", "NEW", "EXCELLENT", "GOOD", "FAIR", "POOR", "USED", "REFURBISHED" ]

$custom_fields

object

Commerce and Content Reports only. key-value pairs that the app developer would like attached to the content item. Attached to events that are retrieved via Exports and sent via Webhooks.

Responses

200

400

429

Was this article helpful?

Logging Standard Events

Shortcuts

Company

Resources