Filters

Track Branch Commerce, Content, Lifecycle, and Custom Events.

Overview

The Branch Events API is a robust tool for tracking events that take place in your app.

These events fall under 4 categories: Commerce, Content, Lifecycle, or Custom.

Benefits

With the Branch Events API, you can track conversion data and include detailed metadata to help you better understand user behavior as it relates to your campaigns.

Try It!

Try out the Events API in your browser, using your Branch data:

Logging Standard Events

Logging Custom Events

Getting Started

Prerequisites

In order to use the Events API, you first need to create a Branch Dashboard.

Authentication

Calls to the Events API require your Branch Key. Your Branch Key can be found in your Branch Dashboard Account Settings.

Learn more about your Branch Account Profile here.

Usage

Logging Standard Events

Use this endpoint to log standard Branch Events.

Standard Branch Events are limited to Commerce, Content, and Lifecycle events. See the "Request Body Parameters" table in this section to see which standard Branch Events you can log with this endpoint.

Request Info

Export Request

POST /v2/event/standard

Request Headers

ParameterValueRequired
content-typeapplication/jsonRecommended
acceptapplication/jsonRecommended

Top Level Request Body Parameters

Top Level ParameterTypeDescriptionRequired
branch_keyStringThe Branch Key for the relevant application.Yes
nameStringThe name of the event to log. Must be one of the standard Branch Event names included below.

Commerce Event Names:
ADD_TO_CART
ADD_TO_WISHLIST
CLICK_AD
VIEW_CART
INITIATE_PURCHASE
ADD_PAYMENT_INFO
PURCHASE
SPEND_CREDITS

Content Event Names:
SEARCH
VIEW_ITEM
VIEW_ITEMS
RATE
SHARE

Lifecycle Event Names:
ADD_TO_CART
ADD_TO_WISHLIST
CLICK_AD
VIEW_CART
INITIATE_PURCHASE
ADD_PAYMENT_INFO
PURCHASE
SPEND_CREDITS
Yes
customer_event_aliasStringThe event alias, as defined by you. Used in addition to the Branch Event name in the name parameter.No
user_dataObjAn object related to user data, containing things like device information and advertising IDs.

Also used to provide information regarding the user for Google DMA compliance.

See user_data table for more.
Yes
custom_dataObjAn object for additional custom key-value pairs that you would like attached to the Branch Event. This is attached to Branch Events that are retrieved via exports and sent via webhooks.No
event_dataObjAn object containing additional data about the specific event, including information about things like currency and revenue.

See event_data table for more.
No
content_itemsObjAn object only for Commerce and Content Branch Events. Contains additional information about specific content.

See content_items table for more.
No

Parameters Included in user_data Object

❗️

Required Identifiers

You must include at least one of the following in user_data:

  1. user_data.developer_identity or,
  2. user_data.browser_fingerprint_id or,
  3. user_data.os=iOS AND user_data.idfa or,
  4. user_data.os=iOS AND user_data.idfv or,
  5. user_data.os=Android AND user_data.android_id or,
  6. user_data.os=Android AND user_data.aaid
Parameters for user_dataTypeDescriptionRequired
user_data.osStringExamples:
Android
iOS
Mac_OS
Linux
Windows
See "Required Identifiers" callout
user_data.os_versionStringThe version of the operating system.No
user_data.environmentStringUsually FULL_APP.No
user_data.aaidStringThe Android Advertising ID.See "Required Identifiers" callout
user_data.android_idStringThe Android hardware ID.See "Required Identifiers" callout
user_data.idfaStringThe iOS advertising ID.See "Required Identifiers" callout
user_data.idfvStringThe iOS vendor ID.See "Required Identifiers" callout
user_data.limit_ad_trackingBoolSet to true if the partner has opted to not be tracked by advertisers.No
user_data.user_agentStringThe user agent of the browser or app where the event occurred. Usually associated with a webview.No
user_data.browser_fingerprint_idStringAn internal-only field for Branch to track browsers.See "Required Identifiers" callout
user_data.http_originStringThe current page URL where the Branch Web SDK logged a web session start.No
user_data.http_referrerStringThe referral URL that led to the current page where the Branch Web SDK logged a web session start.No
user_data.developer_identityStringThe developer-specified identity for a user.See "Required Identifiers" callout
user_data.countryStringThe country code of the user, usually based on device settings or the user agent string.No
user_data.languageStringThe language code of the user, usually based on device settings or the user agent string.No
user_data.ipStringThe IP address for the device where the event occurred.No
user_data.local_ipStringAndroid only: the local IP of the device.

Example: "168.1.1.1"
No
user_data.brandStringThe brand of the device.No
user_data.randomized_device_tokenStringAn internal-only Branch field for tracking devices.No
user_data.app_versionStringThe version of the app downloaded by the user.No
user_data.modelStringThe model of the device.No
user_data.screen_dpiIntThe screen's DPI.No
user_data.screen_heightIntThe screen's height.No
user_data.screen_widthIntThe screen's width.No
user_data.dma_eeaBoolWhether European regulations, including the DMA, apply to this user and conversion.

Set to true if user is included in European Union regulations. For example, if the user is located within the EEA, they are within the scope of DMA.

Set to false if user is considered excluded from European Union regulations.
Required if EU regulations apply to this user

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation
user_data.dma_ad_personalizationBoolWhether end user has granted or denied ads personalization consent.

Set to true if user has granted consent for ads personalization.

Set to false if user has denied consent for ads personalization.
Required if dma_eea is set to true (i.e., EU regulations apply to this user)

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation
user_data.dma_ad_user_dataBoolWhether end user has granted or denied consent for 3P transmission of user level data for ads.

Set to true if user has granted consent for 3P transmission of user-level data for ads.

Set to false if user has 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)

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation

Parameters Included in event_data Object

Parameters for event_dataTypeDescriptionRequired
event_data.transaction_idStringThe partner-specified transaction ID for their internal use.No
event_data.revenueNumThe partner-specified reported revenue for the event.No
event_data.currencyStringThe currency that the revenue, price, shipping, and tax were originally reported in by the partner.No
event_data.shippingNumThe shipping cost associated with the transaction.No
event_data.taxNumThe total tax associated with the transaction.No
event_data.couponStringThe transaction coupon redeemed with the transaction (e.g. "SPRING2017").No
event_data.affiliationStringThe store or affiliation associated with this transaction (e.g. "Google Store").No
event_data.descriptionStringThe description associated with the event, not necessarily specific to any individual content items (see content_items parameter).No
event_data.search_queryStringAdditional search queries.No

Parameters Included in content_items Object

Parameters for content_itemsTypeDescriptionRequired
content_items[i].$content_schemaStringThe category or schema for a piece of content. May be used in the future for analytics. Must be one of the following:

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
No
content_items[i].$og_titleStringThe title for the content item.No
content_items[i].$og_image_urlStringThe image URL for the content item.No
content_items[i].$canonical_identifierStringAllows Branch to unify content/messages for content analytics.No
content_items[i].$publicly_indexableBoolWhether content can be indexed for public use.

Use true for content that can be seen by anyone, and false for content that cannot be indexed for public use.
No
content_items[i].$locally_indexableBoolUse true for content can be indexed for local (device) use, and false for content that cannot be indexed for local use.No
content_items[i].$priceStringThe price for the product or content.No
content_items[i].$quantityStringThe quantity of the item to be ordered.No
content_items[i].$skuStringThe product SKU or product ID.No
content_items[i].$product_nameStringThe product's name.No
content_items[i].$product_brandStringThe product's brand.No
content_items[i].$product_categoryStringThe product's category. Must be one of the following:

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
No
content_items[i].$product_variantStringThe product's variant. Examples would be red or XL, etc.No
content_items[i].$rating_averageNumThe average rating of the item.No
content_items[i].$rating_countNumThe number of ratings for the item.No
content_items[i].$rating_maxNumThe maximum possible rating for the item (e.g. 5.0 if 5 stars is highest possible rating).No
content_items[i].$creation_timestampIntThe time the content was created.No
content_items[i].$exp_dateIntThe time after which this content is no longer valid. The values null and 0 mean no limit.

Should rarely be set.
No
content_items[i].$keywordsArrayAn array of keywords (strings) related to the product.No
content_items[i].$address_streetStringThe street address for a restaurant, business, room (hotel), etc.No
content_items[i].$address_cityStringThe city for a restaurant, business, room (hotel), etc.No
content_items[i].$address_regionStringThe state or region for a restaurant, business, room (hotel), etc.No
content_items[i].$address_countryStringThe country code for a restaurant, business, room (hotel), etc.No
content_items[i].$address_postal_codeStringThe postal/zip code for a restaurant, business, room (hotel), etc.No
content_items[i].$latitudeNumThe latitude for a restaurant, business, room (hotel), etc.No
content_items[i].$longitudeNumThe longitude for a restaurant, business, room (hotel), etc.No
content_items[i].$image_captionsArrayAn array of captions (strings) associated with the image.No
content_items[i].$conditionStringRelates to product condition, and generally used for auctions. Must be one of the following:

OTHER
NEW
EXCELLENT
GOOD
FAIR
POOR
USED
REFURBISHED
No
content_items[i].$custom_fieldsObjA object containing key-value pairs that you would like attached to the content item. Attached to events that are retrieved via exports and sent via webhooks.No

Response Info

Response Codes

Response CodeDefinition
200Success
400Authentication failed
429Rate limit reached

Examples

Example Requests

curl -vvv -d '{
  "name": "PURCHASE",
  "customer_event_alias": "my custom alias",
  "user_data": {
    "advertising_ids": {
      "oaid": "00aa00a0-0000-0a00-a000-aaa0000a0aaa"
    },
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "ip":"000.000.0.0",
    "local_ip": "000.000.0.0",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080,
    "dma_eea": true,
    "dma_ad_personalization": true,
    "dma_ad_user_data": true
  },
  "custom_data": {
    "purchase_loc": "Palo Alto",
    "store_pickup": "unavailable"
  },
  "event_data": {
    "transaction_id": "tras_Id_1232343434",
    "currency": "USD",
    "revenue": 180.2,
    "shipping": 10.5,
    "tax": 13.5,
    "coupon": "promo-1234",
    "affiliation": "high_fi",
    "description": "Preferred purchase"
  },
  "content_items": [
    {
      "$content_schema": "COMMERCE_PRODUCT",
      "$og_title": "Nike Shoe",
      "$og_description": "Start loving your steps",
      "$og_image_url": "http://example.com/img1.jpg",
      "$canonical_identifier": "nike/1234",
      "$publicly_indexable": false,
      "$price": 101.2,
      "$locally_indexable": true,
      "$quantity": 1,
      "$sku": "1101123445",
      "$product_name": "Runner",
      "$product_brand": "Nike",
      "$product_category": "Sporting Goods",
      "$product_variant": "XL",
      "$rating_average": 4.2,
      "$rating_count": 5,
      "$rating_max": 2.2,
      "$creation_timestamp": 1499892854966,
      "$exp_date": 1499892854966,
      "$keywords": [
        "sneakers",
        "shoes"
      ],
      "$address_street": "230 South LaSalle Street",
      "$address_city": "Chicago",
      "$address_region": "IL",
      "$address_country": "US",
      "$address_postal_code": "60604",
      "$latitude": 12.07,
      "$longitude": -97.5,
      "$image_captions": [
        "my_img_caption1",
        "my_img_caption_2"
      ],
      "$condition": "NEW",
      "$custom_fields": "{\"foo1\":\"bar1\",\"foo2\":\"bar2\"}"
    },
    {
      "$og_title": "Nike Woolen Sox",
      "$canonical_identifier": "nike/5324",
      "$og_description": "Fine combed woolen sox",
      "$publicly_indexable": false,
      "$price": 80.2,
      "$locally_indexable": true,
      "$quantity": 5,
      "$sku": "110112467",
      "$product_name": "Woolen Sox",
      "$product_brand": "Nike",
      "$product_category": "Apparel & Accessories",
      "$product_variant": "Xl",
      "$rating_average": 3.3,
      "$rating_count": 5,
      "$rating_max": 2.8,
      "$creation_timestamp": 1499892854966
    }
  ],
  "metadata": {},
  "branch_key": "key_test_XXX"
}' https://api2.branch.io/v2/event/standard
curl -vvv -d '{
  "name": "VIEW_ITEMS",
  "customer_event_alias": "my custom alias",
  "user_data": {
    "advertising_ids": {
      "oaid": "00aa00a0-0000-0a00-a000-aaa0000a0aaa"
    },
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "ip": "000.000.0.0",
    "local_ip": "000.000.0.0",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080,
    "dma_eea": true,
    "dma_ad_personalization": true,
    "dma_ad_user_data": true
  },
  "custom_data": {
    "purchase_loc": "Palo Alto",
    "store_pickup": "unavailable"
  },
  "event_data": {
    "search_query": "red sneakers",
    "description": "Preferred purchase"
  },
  "content_items": [
    {
      "$content_schema": "COMMERCE_PRODUCT",
      "$og_title": "Nike Shoe",
      "$og_description": "Start loving your steps",
      "$og_image_url": "http://example.com/img1.jpg",
      "$canonical_identifier": "nike/1234",
      "$publicly_indexable": false,
      "$price": 101.2,
      "$locally_indexable": true,
      "$sku": "1101123445",
      "$product_name": "Runner",
      "$product_brand": "Nike",
      "$product_category": "Sporting Goods",
      "$product_variant": "XL",
      "$rating_average": 4.2,
      "$rating_count": 5,
      "$rating_max": 2.2,
      "$creation_timestamp": 1499892854966,
      "$exp_date": 1499892854966,
      "$keywords": [
        "sneakers",
        "shoes"
      ],
      "$address_street": "230 South LaSalle Street",
      "$address_city": "Chicago",
      "$address_region": "IL",
      "$address_country": "US",
      "$address_postal_code": "60604",
      "$latitude": 12.07,
      "$longitude": -97.5,
      "$image_captions": [
        "my_img_caption1",
        "my_img_caption_2"
      ],
      "$condition": "NEW",
      "$custom_fields": "{\"foo1\":\"bar1\",\"foo2\":\"bar2\"}"
    },
    {
      "$og_title": "Nike Woolen Sox",
      "$canonical_identifier": "nike/5324",
      "$og_description": "Fine combed woolen sox",
      "$publicly_indexable": false,
      "$price": 80.2,
      "$locally_indexable": true,
      "$sku": "110112467",
      "$product_name": "Woolen Sox",
      "$product_brand": "Nike",
      "$product_category": "Apparel & Accessories",
      "$product_variant": "Xl",
      "$rating_average": 3.3,
      "$rating_count": 5,
      "$rating_max": 2.8,
      "$creation_timestamp": 1499892854966
    }
  ],
  "metadata": {},
  "branch_key": "key_test_XXX"
}' https://api.branch.io/v2/event/standard
curl -vvv -d '{
  "name": "COMPLETE_REGISTRATION",
  "user_data": {
    "advertising_ids": {
      "oaid": "00aa00a0-0000-0a00-a000-aaa0000a0aaa"
    },
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "ip": "000.000.0.0",
    "local_ip": "000.000.0.0",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080,
    "dma_eea": true,
    "dma_ad_personalization": true,
    "dma_ad_user_data": true
  },
  "custom_data": {
    "foo": "bar"
  },
  "event_data": {
    "description": "Preferred purchase"
  },
  "metadata": {},
  "branch_key": "key_test_XXX"
}' https://api.branch.io/v2/event/standard

Example Response

{
  "ascending_only": false,
  "locked": false
}

Logging Custom Events

Request Info

Export Request

POST /v2/event/custom

Request Header Parameters

ParameterValueRequired
content-typeapplication/jsonRecommended
acceptapplication/jsonRecommended

Top Level Request Body Parameters

Top Level ParameterTypeDescriptionRequired
branch_keyStringThe Branch Key for the relevant application.Yes
nameStringThe name of the event to log. Can be a custom event name and include spaces, for example "picture swapped".Yes
user_dataObjAn object related to user data, containing things like device information and advertising IDs.

Also used to provide information regarding the user for Google DMA compliance.

See user_data table for more.
Yes
custom_dataObjAn object for additional custom key-value pairs that you would like attached to the Branch Event. This is attached to Branch Events that are retrieved via exports and sent via webhooks.No
meta_dataObjAn object to store further information about the Branch Event.No
event_dataObjAn object containing additional data about the specific event, including information about things like currency and revenue.

See event_data table for more.
No

Parameters Included in user_data Object

❗️

Required Identifiers

You must include at least one of the following in user_data:

  1. user_data.developer_identity or,
  2. user_data.browser_fingerprint_id or,
  3. user_data.os=iOS AND user_data.idfa or,
  4. user_data.os=iOS AND user_data.idfv or,
  5. user_data.os=Android AND user_data.android_id or,
  6. user_data.os=Android AND user_data.aaid
Parameters for user_dataTypeDescriptionRequired
user_data.osStringExamples:
Android
iOS
Mac_OS
Linux
Windows
See "Required Identifiers" callout
user_data.os_versionStringThe version of the operating system.No
user_data.environmentStringUsually FULL_APP.No
user_data.aaidStringThe Android Advertising ID.See "Required Identifiers" callout
user_data.android_idStringThe Android hardware ID.See "Required Identifiers" callout
user_data.idfaStringThe iOS advertising ID.See "Required Identifiers" callout
user_data.idfvStringThe iOS vendor ID.See "Required Identifiers" callout
user_data.limit_ad_trackingBoolSet to true if the partner has opted to not be tracked by advertisers.No
user_data.user_agentStringThe user agent of the browser or app where the event occurred. Usually associated with a webview.No
user_data.browser_fingerprint_idStringAn internal-only field for Branch to track browsers.See "Required Identifiers" callout
user_data.http_originStringThe current page URL where the Branch Web SDK logged a web session start.No
user_data.http_referrerStringThe referral URL that led to the current page where the Branch Web SDK logged a web session start.No
user_data.developer_identityStringThe developer-specified identity for a user.See "Required Identifiers" callout
user_data.countryStringThe country code of the user, usually based on device settings or the user agent string.No
user_data.languageStringThe language code of the user, usually based on device settings or the user agent string.No
user_data.ipStringThe IP address for the device where the event occurred.No
user_data.local_ipStringAndroid only: the local IP of the device.

Example: "168.1.1.1"
No
user_data.brandStringThe brand of the device.No
user_data.randomized_device_tokenStringAn internal-only Branch field for tracking devices.No
user_data.app_versionStringThe version of the app downloaded by the user.No
user_data.modelStringThe model of the device.No
user_data.screen_dpiIntThe screen's DPI.No
user_data.screen_heightIntThe screen's height.No
user_data.screen_widthIntThe screen's width.No
user_data.dma_eeaBoolWhether European regulations, including the DMA, apply to this user and conversion.

Set to true if user is included in European Union regulations. For example, if the user is located within the EEA, they are within the scope of DMA.

Set to false if user is considered excluded from European Union regulations.
Required if EU regulations apply to this user

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation
user_data.dma_ad_personalizationBoolWhether end user has granted or denied ads personalization consent.

Set to true if user has granted consent for ads personalization.

Set to false if user has denied consent for ads personalization.
Required if dma_eea is set to true (i.e., EU regulations apply to this user)

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation
user_data.dma_ad_user_dataBoolWhether end user has granted or denied consent for 3P transmission of user level data for ads.

Set to true if user has granted consent for 3P transmission of user-level data for ads.

Set to false if user has 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)

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation

Parameters Included in event_data Object

Parameters for event_dataTypeDescriptionRequired
event_data.transaction_idStringThe partner-specified transaction ID for their internal use.No
event_data.revenueNumThe partner-specified reported revenue for the event.No
event_data.currencyStringThe currency that the revenue, price, shipping, and tax were originally reported in by the partner.No
event_data.shippingNumThe shipping cost associated with the transaction.No
event_data.taxNumThe total tax associated with the transaction.No
event_data.couponStringThe transaction coupon redeemed with the transaction (e.g. "SPRING2017").No
event_data.affiliationStringThe store or affiliation associated with this transaction (e.g. "Google Store").No
event_data.descriptionStringThe description associated with the event, not necessarily specific to any individual content items (see content_items parameter).No
event_data.search_queryStringAdditional search queries.No

Response Info

Response Codes

Response CodeDefinition
200Success
400Authentication failed
429Rate limit reached

Example Request & Response

curl -vvv -d '{
  "name": "picture swiped",
  "user_data": {
    "advertising_ids": {
      "oaid": "02ab41d3-7886-4f29-a606-fba4372e9fdc"
    },
    "os": "Android",
    "os_version": 25,
    "environment": "FULL_APP",
    "aaid": "abcdabcd-0123-0123-00f0-000000000000",
    "android_id": "a12300000000",
    "limit_ad_tracking": false,
    "developer_identity": "user123",
    "country": "US",
    "language": "en",
    "ip": "000.000.0.0",
    "local_ip": "000.000.0.0",
    "brand": "LGE",
    "app_version": "1.0.0",
    "model": "Nexus 5X",
    "screen_dpi": 420,
    "screen_height": 1794,
    "screen_width": 1080,
    "dma_eea": true,
    "dma_ad_personalization": true,
    "dma_ad_user_data": true    
  },
  "custom_data": {
    "foo": "bar"
  },
  "meta_data": {
  	"foo": "bar"
  },
  "branch_key": "key_test_XXX"
}' https://api.branch.io/v2/event/custom
{
  "ascending_only": false,
  "locked": false
}

Verify Events Sent

Once you have used the Branch Events API to track a Branch Event, you can verify that it was successfully sent for attribution using the Branch Dashboard's Liveview screen.

Note: Please be patient when using the Liveview screen, as it may take some time for data to flow from Branch's attribution systems to your Branch Dashboard. If the data has not appears in Liveview after 30 minutes, review your API request to see if you may have missed something.