Export Cohort Analytics

Published on Feb 25, 2025

Post

/analytics

This endpoint provisions querying and export Cohort analytics

Security

API Key

Header parameter nameAccess-Token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Query parameters

app_id

stringRequired

app_id | Unique identifier for Branch app of requested data. Either appId or organization_id is required.

limit

integer (int32)

The maximum number of results to return.

Minimum1

Maximum50000

format

string

Format of returned data. json or csv

Valid values[ "csv", "json" ]

Default"csv"

Body parameters

Expand All

object

Cohort Request Body

start_date

string (date) Required

The start of the interval time range represented as an ISO-8601 complete date.

Example2023-05-15

end_date

string (date) Required

The end of the interval time range represented as an ISO-8601 complete date.

Example2023-05-16

data_source

string Required

A string value representing the cohort type

Valid values[ "install_cohort", "reengagement_cohort" ]

Default"install_cohort"

Exampleinstall_cohort

measures

Array of string Required

The cohort measures to return. Limit is 3.See Measure for complete list.

Min items1

Max items3

Default[ "OPEN" ]

Example[ "OPEN" ]

string

Valid values[ "OPEN", "users", "Retention", "ARPPU", "LTV", "ARPU", "revenue", "PURCHASE", "ADD_TO_CART", "ADD_TO_WISHLIST", "VIEW_CART", "INITIATE_PURCHASE", "ADD_PAYMENT_INFO", "SPENG_CREDITS", "RESERVE", "CLICK_AD", "VIEW_AD", "SEARCH", "VIEW_ITEM", "VIEW_ITEMS", "RATE", "SHARE", "COMPLETE_REGISTRATION", "COMPLETE_TUTORIAL", "ACHIEVE_LEVEL", "UNLOCK_ACHIEVEMENT", "INVITE", "LOGIN", "SUBSCRIBE", "START_TRIAL", "cost", "GROSS_PROFIT", "ROI", "ROAS", "eCPA" ]

granularity_band_count

integer Required

Number of time units since the cohort event to return to the user.

Default7

Example7

dimensions

Array of string

An array representing dimension(s) to group by. Limit is 11. See Dimensions for complete list.

Min items1

Max items11

Default[ "install_activity_touch_data_tilde_campaign" ]

Example[ "install_activity_touch_data_tilde_campaign" ]

string

Valid values[ "install_activity_attributed", "install_activity_event_name", "install_activity_touch_type", "install_activity_touch_data_tilde_campaign_id", "install_activity_touch_data_tilde_campaign", "install_activity_touch_data_tilde_channel", "install_activity_touch_data_tilde_feature", "install_activity_touch_data_tilde_stage", "install_activity_touch_data_tilde_tags", "install_activity_touch_data_tilde_advertising_partner_name", "install_activity_touch_data_dollar_3p", "install_activity_touch_data_tilde_secondary_publisher", "install_activity_touch_data_tilde_creative_name", "install_activity_touch_data_tilde_ad_id", "install_activity_touch_data_tilde_ad_set_id", "install_activity_touch_data_tilde_ad_set_name", "install_activity_touch_data_tilde_ad_name", "install_activity_touch_data_tilde_keyword", "install_activity_touch_data_tilde_journey_name", "install_activity_touch_data_tilde_view_name", "install_activity_touch_data_plus_referring_domain", "install_activity_touch_data_plus_via_features", "install_activity_touch_data_plus_web_format", "install_activity_data_os", "install_activity_data_environment", "install_activity_data_platform", "install_activity_data_country_code", "install_activity_data_has_app", "install_activity_data_has_clicked_email", "install_activity_data_has_clicked_ad", "install_activity_timezone_adjusted_day", "install_activity_touch_data_tilde_placement", "install_activity_data_device_type", "install_activity_touch_data_tilde_sub_site_name", "install_activity_data_brand", "install_activity_data_geo_country_en", "install_activity_data_model", "install_activity_data_geo_region_en", "install_activity_touch_data_tilde_customer_secondary_publisher", "install_activity_touch_data_tilde_customer_placement", "install_activity_touch_data_tilde_customer_sub_site_name", "install_activity_touch_data_tilde_customer_campaign", "install_activity_touch_data_tilde_customer_ad_set_name", "install_activity_touch_data_tilde_customer_ad_name", "install_activity_touch_data_tilde_customer_keyword", "install_activity_touch_data_tilde_agency_id", "install_activity_touch_data_tilde_agency", "customer_event_alias", "reengagement_activity_attributed", "reengagement_activity_event_name", "reengagement_activity_touch_type", "reengagement_activity_touch_data_tilde_campaign_id", "reengagement_activity_touch_data_tilde_campaign", "reengagement_activity_touch_data_tilde_channel", "reengagement_activity_touch_data_tilde_feature", "reengagement_activity_touch_data_tilde_stage", "reengagement_activity_touch_data_tilde_tags", "reengagement_activity_touch_data_tilde_advertising_partner_name", "reengagement_activity_touch_data_dollar_3p", "reengagement_activity_touch_data_tilde_secondary_publisher", "reengagement_activity_touch_data_tilde_creative_name", "reengagement_activity_touch_data_tilde_ad_id", "reengagement_activity_touch_data_tilde_ad_set_id", "reengagement_activity_touch_data_tilde_ad_set_name", "reengagement_activity_touch_data_tilde_ad_name", "reengagement_activity_touch_data_tilde_keyword", "reengagement_activity_touch_data_tilde_journey_name", "reengagement_activity_touch_data_tilde_view_name", "reengagement_activity_touch_data_plus_referring_domain", "reengagement_activity_touch_data_plus_via_features", "reengagement_activity_touch_data_plus_web_format", "reengagement_activity_data_os", "reengagement_activity_data_environment", "reengagement_activity_data_platform", "reengagement_activity_data_country_code", "reengagement_activity_data_has_app", "reengagement_activity_data_has_clicked_email", "reengagement_activity_data_has_clicked_ad", "reengagement_activity_timezone_adjusted_day", "reengagement_activity_touch_data_tilde_placement", "reengagement_activity_data_device_type", "reengagement_activity_touch_data_tilde_sub_site_name", "reengagement_activity_data_brand", "reengagement_activity_data_geo_country_en", "reengagement_activity_data_model", "reengagement_activity_data_geo_region_en", "reengagement_activity_touch_data_tilde_customer_secondary_publisher", "reengagement_activity_touch_data_tilde_customer_placement", "reengagement_activity_touch_data_tilde_customer_sub_site_name", "reengagement_activity_touch_data_tilde_customer_campaign", "reengagement_activity_touch_data_tilde_customer_ad_set_name", "reengagement_activity_touch_data_tilde_customer_ad_name", "reengagement_activity_touch_data_tilde_customer_keyword", "reengagement_activity_touch_data_tilde_agency_id", "reengagement_activity_touch_data_tilde_agency", "user_data_platform", "user_data_environment", "user_data_geo_country_code", "user_data_os", "user_data_has_app", "user_data_standard_events_completed", "user_data_custom_events_completed", "user_data_has_clicked_ad", "user_data_has_clicked_email", "user_data_brand", "user_data_device_type", "user_data_model", "app_id" ]

filter

object (filterBodyDictionary)

"Keys are same as dimensions. Values are an array of values to match for the dimension. An object defining filters to match or disallow certain values. Example: ["install_activity_touch_data_tilde_campaign": ["A4G"]]"

Example{ "install_activity_touch_data_tilde_campaign": [ "A4G" ] }

app_id

Array of string

string

install_activity_attributed

Array of string

string

Valid values[ "True", "False" ]

ExampleTrue

install_activity_event_name

Array of string

string

install_activity_touch_type

Array of string

string

Valid values[ "CLICK", "IMPRESSION", "WEB_TO_APP_AUTO_REDIRECT" ]

install_activity_touch_data_tilde_campaign_id

Array of string

string

install_activity_touch_data_tilde_campaign

Array of string

string

install_activity_touch_data_tilde_channel

Array of string

string

install_activity_touch_data_tilde_feature

Array of string

string

install_activity_touch_data_tilde_stage

Array of string

string

install_activity_touch_data_tilde_tags

Array of string

string

install_activity_touch_data_tilde_advertising_partner_name

Array of string

string

install_activity_touch_data_dollar_3p

Array of string

string

install_activity_touch_data_tilde_secondary_publisher

Array of string

string

install_activity_touch_data_tilde_creative_name

Array of string

string

install_activity_touch_data_tilde_ad_id

Array of string

string

install_activity_touch_data_tilde_ad_set_id

Array of string

string

install_activity_touch_data_tilde_ad_set_name

Array of string

string

install_activity_touch_data_tilde_ad_name

Array of string

string

install_activity_touch_data_tilde_keyword

Array of string

string

install_activity_touch_data_tilde_journey_name

Array of string

string

install_activity_touch_data_tilde_view_name

Array of string

string

install_activity_touch_data_plus_referring_domain

Array of string

string

install_activity_touch_data_plus_via_features

Array of string

string

Valid values[ "EMAIL", "ADS", "DESKTOP_JOURNEYS", "MOBILE_JOURNEYS", "DESKTOP_DEEPVIEWS", "MOBILE_DEEPVIEWS", "SOCIAL", "QUICK_LINKS" ]

install_activity_touch_data_plus_web_format

Array of string

string

Valid values[ "AMP", "INSTANT_ARTICLES" ]

install_activity_data_os

Array of string

string

Valid values[ "AMAZON_FIRE", "AMAZON_FIRE_TV", "ANDROID", "BADA", "BEOS", "BLACKBERRY", "BSD", "CENTOS", "CHROMIUM_OS", "DEBIAN", "DRAGONFLY", "FEDORA", "FIREFOX_OS", "FREEBSD", "GENTOO", "GNU", "IOS", "JOLI", "KUBUNTU", "LINUX", "MAC_OS", "MANDRIVA", "MEEGO", "MINT", "NETBSD", "NINTENDO", "OPENBSD", "OS_2", "OTHER", "PLAYSTATION", "RIM_TABLET_OS", "ROBOTS", "SAILFISH", "SLACKWARE", "SOLARIS", "SUSE", "SYMBIAN", "TIZEN", "TVOS", "UBUNTU", "UNIX", "WINDOWS", "WINDOWS_PHONE", "ZENWALK", "ROKU", "SAMSUNG", "ANDROID_TV", "LG", "PANASONIC" ]

install_activity_data_environment

Array of string

string

Valid values[ "FULL_WEB", "FULL_APP", "IMESSAGE_APP", "INSTANT_APP", "TV_WEB", "TV_APP" ]

install_activity_data_platform

Array of string

string

Valid values[ "ANDROID_APP", "ANDROID_TV", "ANDROID_WEB", "DESKTOP_WEB", "FIRE_APP", "IOS_APP", "IOS_TV", "IOS_WEB", "MAC_APP", "OTHER", "ROBOT", "WINDOWS_APP", "DESKTOP_APP", "TV_WEB", "TV_APP" ]

install_activity_data_country_code

Array of string

string

install_activity_data_has_app

Array of string

string

install_activity_data_has_clicked_email

Array of string

string

install_activity_data_has_clicked_ad

Array of string

string

install_activity_timezone_adjusted_day

Array of string

string

install_activity_touch_data_tilde_placement

Array of string

string

install_activity_data_device_type

Array of string

string

Valid values[ "ANDROID_PHONE", "ANDROID_TABLET", "DESKTOP", "IOS_PHONE", "IOS_TABLET", "OTHER", "TV_OS", "UNKNOWN", "WINDOWS_PHONE", "WINDOWS_TABLET" ]

install_activity_touch_data_tilde_sub_site_name

Array of string

string

install_activity_data_brand

Array of string

string

install_activity_data_geo_country_en

Array of string

string

install_activity_data_model

Array of string

string

install_activity_data_geo_region_en

Array of string

string

install_activity_touch_data_tilde_customer_secondary_publisher

Array of string

string

install_activity_touch_data_tilde_customer_placement

Array of string

string

install_activity_touch_data_tilde_customer_sub_site_name

Array of string

string

install_activity_touch_data_tilde_customer_campaign

Array of string

string

install_activity_touch_data_tilde_customer_ad_set_name

Array of string

string

install_activity_touch_data_tilde_customer_ad_name

Array of string

string

install_activity_touch_data_tilde_customer_keyword

Array of string

string

install_activity_touch_data_tilde_agency_id

Array of string

string

install_activity_touch_data_tilde_agency

Array of string

string

customer_event_alias

Array of string

string

reengagement_activity_attributed

Array of string

string

reengagement_activity_event_name

Array of string

string

reengagement_activity_touch_type

Array of string

string

Valid values[ "CLICK", "IMPRESSION", "WEB_TO_APP_AUTO_REDIRECT" ]

reengagement_activity_touch_data_tilde_campaign_id

Array of string

string

reengagement_activity_touch_data_tilde_campaign

Array of string

string

reengagement_activity_touch_data_tilde_channel

Array of string

string

reengagement_activity_touch_data_tilde_feature

Array of string

string

reengagement_activity_touch_data_tilde_stage

Array of string

string

reengagement_activity_touch_data_tilde_tags

Array of string

string

reengagement_activity_touch_data_tilde_advertising_partner_name

Array of string

string

reengagement_activity_touch_data_dollar_3p

Array of string

string

reengagement_activity_touch_data_tilde_secondary_publisher

Array of string

string

reengagement_activity_touch_data_tilde_creative_name

Array of string

string

reengagement_activity_touch_data_tilde_ad_id

Array of string

string

reengagement_activity_touch_data_tilde_ad_set_id

Array of string

string

reengagement_activity_touch_data_tilde_ad_set_name

Array of string

string

reengagement_activity_touch_data_tilde_ad_name

Array of string

string

reengagement_activity_touch_data_tilde_keyword

Array of string

string

reengagement_activity_touch_data_tilde_journey_name

Array of string

string

reengagement_activity_touch_data_tilde_view_name

Array of string

string

reengagement_activity_touch_data_plus_referring_domain

Array of string

string

reengagement_activity_touch_data_plus_via_features

Array of string

string

reengagement_activity_touch_data_plus_web_format

Array of string

string

reengagement_activity_data_os

Array of string

string

reengagement_activity_data_environment

Array of string

string

reengagement_activity_data_platform

Array of string

string

reengagement_activity_data_country_code

Array of string

string

reengagement_activity_data_has_app

Array of string

string

reengagement_activity_data_has_clicked_email

Array of string

string

reengagement_activity_data_has_clicked_ad

Array of string

string

reengagement_activity_timezone_adjusted_day

Array of string

string

reengagement_activity_touch_data_tilde_placement

Array of string

string

reengagement_activity_data_device_type

Array of string

string

reengagement_activity_touch_data_tilde_sub_site_name

Array of string

string

reengagement_activity_data_brand

Array of string

string

reengagement_activity_data_geo_country_en

Array of string

string

reengagement_activity_data_model

Array of string

string

reengagement_activity_data_geo_region_en

Array of string

string

reengagement_activity_touch_data_tilde_customer_secondary_publisher

Array of string

string

reengagement_activity_touch_data_tilde_customer_placement

Array of string

string

reengagement_activity_touch_data_tilde_customer_sub_site_name

Array of string

string

reengagement_activity_touch_data_tilde_customer_campaign

Array of string

string

reengagement_activity_touch_data_tilde_customer_ad_set_name

Array of string

string

reengagement_activity_touch_data_tilde_customer_ad_name

Array of string

string

reengagement_activity_touch_data_tilde_customer_keyword

Array of string

string

reengagement_activity_touch_data_tilde_agency_id

Array of string

string

reengagement_activity_touch_data_tilde_agency

Array of string

string

user_data_platform

Array of string

string

user_data_environment

Array of string

string

user_data_geo_country_code

Array of string

string

user_data_os

Array of string

string

user_data_has_app

Array of string

string

user_data_standard_events_completed

Array of string

string

user_data_custom_events_completed

Array of string

string

user_data_has_clicked_ad

Array of string

string

user_data_has_clicked_email

Array of string

string

user_data_brand

Array of string

string

user_data_device_type

Array of string

string

user_data_model

Array of string

string

property*

Array of string additionalProperties

string

ordered

string

Order of response based on ordered_by value.

Valid values[ "ascending", "descending" ]

Default"descending"

Exampledescending

ordered_by

string

The dimension used for sorting

Default"install_activity_touch_data_tilde_campaign"

Exampleinstall_activity_touch_data_tilde_campaign

unique

boolean

Whether or not to return unique values.

Defaultfalse

cumulative

boolean

If true, sum across bands so that a given band value is the sum of all preceding values plus the band value.

Defaultfalse

per_user

boolean

If true, divide each band value by the user count.

Defaultfalse

granularity

string

The time granularity that each band value will represent.

Valid values[ "day", "week", "month" ]

Default"day"

Exampleday

enable_install_recalculation

boolean

If true, then Branch will de-dupe unattributed installs caused by duplicate events from non-opt-in users coming from paid ads. (result from iOS 14.5 privacy changes).

Defaulttrue

Responses

200

Status of aggregate export

object

job_id

string

Unique identifier used to retrieve job status and data.

Example0000-XXxx

code

string

HTTP code representing the outcome of the export request.

Example200

status_url

string

More information about the subscription's status.

Examplehttps://api2.branch.io/v2/analytics/{UNIQUE_ALPHANUMERICAL_STATUS_PATH_HERE}

error_message

string

Error message if the export call fails

ExampleN/A

400

Authentication Failed

Result

"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"

Expand All

object

error

object (inline_response_400_error)

message

string

ExampleAuthentication failed !

code

integer

Example400

Was this article helpful?

Export Cohort Analytics

Shortcuts

Company

Resources