Post
/scheduled-exports/logs/subscribe
Set up a new scheduled log export subscription. Supported at both app and org level. The result is a subscription that specifies what data will be exported (e.g. topic, columns, filters) and where data will be exported to
Security
API Key
Query parameter nameapp_id
app_id | Unique identifier for Branch app of requested data.
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.
Body parameters
object
Create Scheduled Log Export Subscription Request Body
report
object Required
Information about the report that should be generated.
cadence
string Required
How frequently the report is generated, and for what time period it is generated. Options: hourly or daily.
Valid values[
"hourly",
"daily"
]
Default"hourly"
Examplehourly
response_format
string Required
format in which the export data is delivered. Options: csv, json, parquet.
Valid values[
"csv",
"json",
"parquet"
]
Default"csv"
Examplecsv
response_format_compression
string
method by which the export data should be compressed. Options: gz, snappy. Defaults to gz if not specified.
Valid values[
"gz",
"snappy"
]
Default"gz"
Examplegz
report_type
string Required
An array representing event type of your report. See Available Topics the for complete list.
Valid values[
"eo_impression",
"eo_click",
"eo_web_to_app_auto_redirect",
"eo_branch_cta_view",
"eo_open",
"eo_install",
"eo_reinstall",
"eo_web_session_start",
"eo_pageview",
"eo_commerce_event",
"eo_custom_event",
"eo_content_event",
"eo_dismissal",
"eo_user_lifecycle_event",
"skadnetwork_valid_messages",
"eo_click_blocked",
"eo_impression_blocked",
"eo_install_blocked",
"eo_reinstall_blocked",
"eo_open_blocked",
"eo_web_session_start_blocked",
"eo_pageview_blocked",
"eo_custom_event_blocked",
"eo_content_event_blocked",
"eo_commerce_event_blocked",
"eo_user_lifecycle_event_blocked",
"eo_branch_cta_view_blocked",
"eo_web_to_app_auto_redirect_blocked"
]
Default"eo_install"
Exampleeo_install
report_fields
Array of string Required
An array representing fields/columns available in your report. See Available EO Fields the for complete list.
Default[
"name"
]
Example[
"name"
]
string
Valid values[
"app_id",
"app_name",
"attributed",
"content_items",
"custom_data",
"customer_event_alias",
"days_from_last_attributed_touch_to_event",
"deep_linked",
"di_match_click_token",
"event_data_ad_type",
"event_data_affiliation",
"event_data_coupon",
"event_data_currency",
"event_data_description",
"event_data_exchange_rate",
"event_data_revenue",
"event_data_revenue_in_usd",
"event_data_search_query",
"event_data_shipping",
"event_data_tax",
"event_data_transaction_id",
"event_data_local_currency",
"event_data_local_currency_exchange_rate",
"event_data_revenue_in_local_currency",
"event_timestamp",
"existing_user",
"external_intent_uri",
"first_event_for_user",
"hours_from_last_attributed_touch_to_event",
"id",
"install_activity_attributed",
"install_activity_data_has_clicked_ad",
"install_activity_data_has_clicked_email",
"install_activity_timestamp",
"install_activity_touch_data_additional_data_tilde_ad_id",
"install_activity_touch_data_additional_data_tilde_ad_set_id",
"install_activity_touch_data_additional_data_tilde_campaign_id",
"install_activity_touch_data_additional_data_tilde_creative_id",
"install_activity_touch_data_dollar_3p",
"install_activity_touch_data_plus_via_features",
"install_activity_touch_data_plus_web_format",
"install_activity_touch_data_tilde_ad_name",
"install_activity_touch_data_tilde_ad_set_name",
"install_activity_touch_data_tilde_advertising_partner_id",
"install_activity_touch_data_tilde_agency",
"install_activity_touch_data_tilde_agency_id",
"install_activity_touch_data_tilde_campaign",
"install_activity_touch_data_tilde_channel",
"install_activity_touch_data_tilde_creative_name",
"install_activity_touch_data_tilde_customer_ad_name",
"install_activity_touch_data_tilde_customer_ad_set_name",
"install_activity_touch_data_tilde_customer_campaign",
"install_activity_touch_data_tilde_customer_keyword",
"install_activity_touch_data_tilde_customer_placement",
"install_activity_touch_data_tilde_customer_secondary_publisher",
"install_activity_touch_data_tilde_customer_sub_site_name",
"install_activity_touch_data_tilde_feature",
"install_activity_touch_data_tilde_journey_name",
"install_activity_touch_data_tilde_keyword",
"install_activity_touch_data_tilde_placement",
"install_activity_touch_data_tilde_secondary_publisher",
"install_activity_touch_data_tilde_stage",
"install_activity_touch_data_tilde_tags",
"install_activity_touch_data_tilde_view_name",
"install_activity_touch_type",
"last_attributed_touch_data_custom_fields",
"last_attributed_touch_data_plus_current_feature",
"last_attributed_touch_data_tilde_id",
"last_attributed_touch_data_plus_touch_id",
"last_cta_view_data_plus_touch_id",
"last_attributed_touch_data_plus_via_features",
"last_attributed_touch_data_plus_web_format",
"last_attributed_touch_data_tilde_ad_id",
"last_attributed_touch_data_tilde_ad_name",
"last_attributed_touch_data_tilde_ad_set_id",
"last_attributed_touch_data_tilde_ad_set_name",
"last_attributed_touch_data_tilde_advertising_account_name",
"last_attributed_touch_data_tilde_advertising_account_id",
"last_attributed_touch_data_tilde_advertising_partner_id",
"last_attributed_touch_data_tilde_advertising_partner_name",
"last_attributed_touch_data_tilde_agency",
"last_attributed_touch_data_tilde_agency_id",
"last_attributed_touch_data_tilde_banner_dimensions",
"last_attributed_touch_data_tilde_branch_ad_format",
"last_attributed_touch_data_tilde_campaign",
"last_attributed_touch_data_tilde_campaign_id",
"last_attributed_touch_data_tilde_campaign_type",
"last_attributed_touch_data_tilde_channel",
"last_attributed_touch_data_tilde_creative_name",
"last_attributed_touch_data_tilde_creative_id",
"last_attributed_touch_data_tilde_customer_ad_name",
"last_attributed_touch_data_tilde_customer_ad_set_name",
"last_attributed_touch_data_tilde_customer_campaign",
"last_attributed_touch_data_tilde_customer_keyword",
"last_attributed_touch_data_tilde_customer_placement",
"last_attributed_touch_data_tilde_customer_secondary_publisher",
"last_attributed_touch_data_tilde_customer_sub_site_name",
"last_attributed_touch_data_tilde_external_touch_id",
"last_attributed_touch_data_tilde_feature",
"last_attributed_touch_data_tilde_journey_id",
"last_attributed_touch_data_tilde_journey_name",
"last_attributed_touch_data_tilde_keyword",
"last_attributed_touch_data_tilde_keyword_id",
"last_attributed_touch_data_tilde_optimization_model",
"last_attributed_touch_data_tilde_placement",
"last_attributed_touch_data_tilde_placement_id",
"last_attributed_touch_data_tilde_secondary_ad_format",
"last_attributed_touch_data_tilde_secondary_publisher",
"last_attributed_touch_data_tilde_secondary_publisher_id",
"last_attributed_touch_data_tilde_stage",
"last_attributed_touch_data_tilde_sub_site_name",
"last_attributed_touch_data_tilde_tags",
"last_attributed_touch_data_tilde_technology_partner",
"last_attributed_touch_data_tilde_touch_subtype",
"last_attributed_touch_data_tilde_view_id",
"last_attributed_touch_data_tilde_view_name",
"last_attributed_touch_timestamp",
"last_attributed_touch_timestamp_iso",
"last_attributed_touch_type",
"last_attributed_touch_data_tilde_organic_search_url",
"last_cta_view_data_custom_fields",
"last_cta_view_data_dollar_3p",
"last_attributed_touch_data_plus_referring_domain",
"last_cta_view_data_plus_via_features",
"last_cta_view_data_plus_web_format",
"last_cta_view_data_tilde_ad_id",
"last_cta_view_data_tilde_ad_name",
"last_cta_view_data_tilde_ad_set_id",
"last_cta_view_data_tilde_ad_set_name",
"last_cta_view_data_tilde_advertising_partner_name",
"last_cta_view_data_tilde_agency",
"last_cta_view_data_tilde_banner_dimensions",
"last_cta_view_data_tilde_branch_ad_format",
"last_cta_view_data_tilde_campaign",
"last_cta_view_data_tilde_campaign_id",
"last_cta_view_data_tilde_campaign_type",
"last_cta_view_data_tilde_channel",
"last_cta_view_data_tilde_creative_id",
"last_cta_view_data_tilde_creative_name",
"last_cta_view_data_tilde_external_touch_id",
"last_cta_view_data_tilde_feature",
"last_cta_view_data_tilde_id",
"last_cta_view_data_tilde_keyword_id",
"last_cta_view_data_tilde_optimization_model",
"last_cta_view_data_tilde_placement",
"last_cta_view_data_tilde_secondary_ad_format",
"last_cta_view_data_tilde_secondary_publisher",
"last_cta_view_data_tilde_stage",
"last_cta_view_data_tilde_tags",
"last_cta_view_data_tilde_technology_partner",
"last_cta_view_timestamp",
"last_cta_view_timestamp_iso",
"match_guaranteed",
"minutes_from_last_attributed_touch_to_event",
"name",
"organization_id",
"organization_name",
"origin",
"reengagement_activity_attributed",
"reengagement_activity_data_has_clicked_ad",
"reengagement_activity_data_has_clicked_email",
"reengagement_activity_timestamp",
"reengagement_activity_touch_data_additional_data_tilde_ad_id",
"reengagement_activity_touch_data_additional_data_tilde_ad_set_id",
"reengagement_activity_touch_data_additional_data_tilde_campaign_id",
"reengagement_activity_touch_data_additional_data_tilde_creative_id",
"reengagement_activity_touch_data_dollar_3p",
"reengagement_activity_touch_data_plus_via_features",
"reengagement_activity_touch_data_plus_web_format",
"reengagement_activity_touch_data_tilde_ad_name",
"reengagement_activity_touch_data_tilde_ad_set_name",
"reengagement_activity_touch_data_tilde_advertising_partner_id",
"reengagement_activity_touch_data_tilde_advertising_partner_name",
"reengagement_activity_touch_data_tilde_agency",
"reengagement_activity_touch_data_tilde_agency_id",
"reengagement_activity_touch_data_tilde_campaign",
"reengagement_activity_touch_data_tilde_channel",
"reengagement_activity_touch_data_tilde_creative_name",
"reengagement_activity_touch_data_tilde_customer_ad_name",
"reengagement_activity_touch_data_tilde_customer_ad_set_name",
"reengagement_activity_touch_data_tilde_customer_campaign",
"reengagement_activity_touch_data_tilde_customer_keyword",
"reengagement_activity_touch_data_tilde_customer_placement",
"reengagement_activity_touch_data_tilde_customer_secondary_publisher",
"reengagement_activity_touch_data_tilde_customer_sub_site_name",
"reengagement_activity_touch_data_tilde_feature",
"reengagement_activity_touch_data_tilde_journey_name",
"reengagement_activity_touch_data_tilde_keyword",
"reengagement_activity_touch_data_tilde_placement",
"reengagement_activity_touch_data_tilde_secondary_publisher",
"reengagement_activity_touch_data_tilde_stage",
"reengagement_activity_touch_data_tilde_tags",
"reengagement_activity_touch_data_tilde_view_name",
"reengagement_activity_touch_type",
"referrer_click_timestamp",
"seconds_from_install_to_event",
"seconds_from_last_attributed_touch_to_event",
"seconds_from_last_attributed_touch_to_store_install_begin",
"site_event_items_count",
"store_install_begin_timestamp",
"timestamp",
"timestamp_iso",
"user_data_aaid",
"user_data_android_id",
"user_data_app_package_name",
"user_data_app_version",
"user_data_brand",
"user_data_browser",
"user_data_build",
"user_data_cpu_type",
"user_data_cross_platform_id",
"user_data_developer_identity",
"user_data_device_type",
"user_data_environment",
"user_data_geo_city_code",
"user_data_geo_city_en",
"user_data_geo_country_code",
"user_data_geo_country_en",
"user_data_geo_dma_code",
"user_data_geo_lat",
"user_data_geo_lon",
"user_data_geo_postal_code",
"user_data_geo_region_en",
"user_data_geo_region_code",
"user_data_http_referrer",
"user_data_idfa",
"user_data_idfv",
"user_data_installer_package_name",
"user_data_internet_connection_type",
"user_data_ip",
"user_data_is_jailbroken",
"user_data_kindle_id",
"user_data_language",
"user_data_limit_ad_tracking",
"user_data_model",
"user_data_os",
"user_data_os_version",
"user_data_os_version_android",
"user_data_past_cross_platform_ids",
"user_data_platform",
"user_data_prob_cross_platform_ids",
"user_data_roku_rida",
"user_data_screen_height",
"user_data_screen_width",
"user_data_sdk_version",
"user_data_user_agent",
"user_data_windows_aid",
"user_data_device_locale",
"user_data_carrier_name",
"user_data_opted_in_status",
"user_data_app_store"
]
Exampletimestamp
filter
Array of string
Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. Example: ["eq", "name", "PURCHASE"].
NOTE: ADD EACH SYNTAX AS ITS OWN STRING
string
destination
object Required
Information about where a finished report is stored and how it can be accessed
Responses
200
401
404
500
Status of aggregate export
object
subscription_id
string
A persistent id for this subscription, used to check the status, locate recent export jobs, and make modifications
ExampleXXXX-0000-xxxx
status
string
if PENDING, Branch is still working on an initial export to test out this subscription. If ACTIVE then the subscription was set up successfully. If FAILED then the test export was unsuccessful.
Valid values[
"PENDING",
"ACTIVE",
"FAILED"
]
ExamplePENDING
description
string
More information about the subscription's status.
ExampleGenerating sample report. Subscription will finish after Report is uploaded
subscription_url
string
Get details on this subscription. See the section "Get details on one log export subscription" below.
Examplehttps://api2.branch.io/scheduled-exports/exports/logs/subscription/{SUBSCRIPTION_ID_HERE}?app_id={APP_ID_HERE}