Post
/logs
By passing in the appropriate options, you can find and queue all records that match search criteria for export and build the relevant export request accordingly.
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
Custom Exports Request Body
start_date
string (date-time) Required
The start of the interval time range represented as an ISO-8601 complete datetime including Hours, Minutes, Seconds, and Milliseconds. Datetime must be within the last 120 days.
Example2023-05-15T00:00:00Z
end_date
string (date-time) Required
The end of the interval time range represented as an ISO-8601 complete datetime including Hours, Minutes, Seconds, and Milliseconds.
Example2023-05-15T01:59:59Z
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\"",
"\"cost\"",
"\"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\"",
"\"eo_san_touch\""
]
Default"eo_open"
Exampleeo_open
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_dollar_3p\"",
"\"last_attributed_touch_data_dollar_marketing_title\"",
"\"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_attributed_touch_data_plus_url\"",
"\"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_cpp_level\"",
"\"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_oaid\"",
"\"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\"",
"\"body_transaction_id\"",
"\"body_version\"",
"\"body_ad_network_id\"",
"\"body_campaign_id\"",
"\"body_app_id\"",
"\"body_attribution_signature\"",
"\"body_redownload\"",
"\"body_source_app_id\"",
"\"body_conversion_value\"",
"\"body_fidelity_type\"",
"\"body_did_win\"",
"\"invalid_reason\"",
"\"event_timezone_adjusted_day\"",
"\"annotation_dollar_3p\"",
"\"annotation_conversion_value_mapped_value\"",
"\"annotation_customer_event_alias\"",
"\"annotation_revenue_lower\"",
"\"annotation_revenue_upper\"",
"\"advertiser_copy\""
]
Exampletimestamp
limit
integer (int32) Required
The maximum number of results to return.
Minimum1.0
Default100
Example100
timezone
string
Timezone for results. Accepts tz database strings like ‘America/Los_Angeles’. Results are returned in the Branch Dashboard timezone if not provided. Will default to UTC only if Branch Dashboard timezone is not set.
Valid values[
"\"Africa/Abidjan\"",
"\"Africa/Accra\"",
"\"Africa/Addis_Ababa\"",
"\"Africa/Algiers\"",
"\"Africa/Asmara\"",
"\"Africa/Asmera\"",
"\"Africa/Bamako\"",
"\"Africa/Bangui\"",
"\"Africa/Banjul\"",
"\"Africa/Bissau\"",
"\"Africa/Blantyre\"",
"\"Africa/Brazzaville\"",
"\"Africa/Bujumbura\"",
"\"Africa/Cairo\"",
"\"Africa/Casablanca\"",
"\"Africa/Ceuta\"",
"\"Africa/Conakry\"",
"\"Africa/Dakar\"",
"\"Africa/Dar_es_Salaam\"",
"\"Africa/Djibouti\"",
"\"Africa/Douala\"",
"\"Africa/El_Aaiun\"",
"\"Africa/Freetown\"",
"\"Africa/Gaborone\"",
"\"Africa/Harare\"",
"\"Africa/Johannesburg\"",
"\"Africa/Juba\"",
"\"Africa/Kampala\"",
"\"Africa/Khartoum\"",
"\"Africa/Kigali\"",
"\"Africa/Kinshasa\"",
"\"Africa/Lagos\"",
"\"Africa/Libreville\"",
"\"Africa/Lome\"",
"\"Africa/Luanda\"",
"\"Africa/Lubumbashi\"",
"\"Africa/Lusaka\"",
"\"Africa/Malabo\"",
"\"Africa/Maputo\"",
"\"Africa/Maseru\"",
"\"Africa/Mbabane\"",
"\"Africa/Mogadishu\"",
"\"Africa/Monrovia\"",
"\"Africa/Nairobi\"",
"\"Africa/Ndjamena\"",
"\"Africa/Niamey\"",
"\"Africa/Nouakchott\"",
"\"Africa/Ouagadougou\"",
"\"Africa/Porto-Novo\"",
"\"Africa/Sao_Tome\"",
"\"Africa/Timbuktu\"",
"\"Africa/Tripoli\"",
"\"Africa/Tunis\"",
"\"Africa/Windhoek\"",
"\"America/Adak\"",
"\"America/Anchorage\"",
"\"America/Anguilla\"",
"\"America/Antigua\"",
"\"America/Araguaina\"",
"\"America/Argentina/Buenos_Aires\"",
"\"America/Argentina/Catamarca\"",
"\"America/Argentina/ComodRivadavia\"",
"\"America/Argentina/Cordoba\"",
"\"America/Argentina/Jujuy\"",
"\"America/Argentina/La_Rioja\"",
"\"America/Argentina/Mendoza\"",
"\"America/Argentina/Rio_Gallegos\"",
"\"America/Argentina/Salta\"",
"\"America/Argentina/San_Juan\"",
"\"America/Argentina/San_Luis\"",
"\"America/Argentina/Tucuman\"",
"\"America/Argentina/Ushuaia\"",
"\"America/Aruba\"",
"\"America/Asuncion\"",
"\"America/Atikokan\"",
"\"America/Atka\"",
"\"America/Bahia\"",
"\"America/Bahia_Banderas\"",
"\"America/Barbados\"",
"\"America/Belem\"",
"\"America/Belize\"",
"\"America/Blanc-Sablon\"",
"\"America/Boa_Vista\"",
"\"America/Bogota\"",
"\"America/Boise\"",
"\"America/Buenos_Aires\"",
"\"America/Cambridge_Bay\"",
"\"America/Campo_Grande\"",
"\"America/Cancun\"",
"\"America/Caracas\"",
"\"America/Catamarca\"",
"\"America/Cayenne\"",
"\"America/Cayman\"",
"\"America/Chicago\"",
"\"America/Chihuahua\"",
"\"America/Coral_Harbour\"",
"\"America/Cordoba\"",
"\"America/Costa_Rica\"",
"\"America/Creston\"",
"\"America/Cuiaba\"",
"\"America/Curacao\"",
"\"America/Danmarkshavn\"",
"\"America/Dawson\"",
"\"America/Dawson_Creek\"",
"\"America/Denver\"",
"\"America/Detroit\"",
"\"America/Dominica\"",
"\"America/Edmonton\"",
"\"America/Eirunepe\"",
"\"America/El_Salvador\"",
"\"America/Ensenada\"",
"\"America/Fort_Nelson\"",
"\"America/Fort_Wayne\"",
"\"America/Fortaleza\"",
"\"America/Glace_Bay\"",
"\"America/Godthab\"",
"\"America/Goose_Bay\"",
"\"America/Grand_Turk\"",
"\"America/Grenada\"",
"\"America/Guadeloupe\"",
"\"America/Guatemala\"",
"\"America/Guayaquil\"",
"\"America/Guyana\"",
"\"America/Halifax\"",
"\"America/Havana\"",
"\"America/Hermosillo\"",
"\"America/Indiana/Indianapolis\"",
"\"America/Indiana/Knox\"",
"\"America/Indiana/Marengo\"",
"\"America/Indiana/Petersburg\"",
"\"America/Indiana/Tell_City\"",
"\"America/Indiana/Vevay\"",
"\"America/Indiana/Vincennes\"",
"\"America/Indiana/Winamac\"",
"\"America/Indianapolis\"",
"\"America/Inuvik\"",
"\"America/Iqaluit\"",
"\"America/Jamaica\"",
"\"America/Jujuy\"",
"\"America/Juneau\"",
"\"America/Kentucky/Louisville\"",
"\"America/Kentucky/Monticello\"",
"\"America/Knox_IN\"",
"\"America/Kralendijk\"",
"\"America/La_Paz\"",
"\"America/Lima\"",
"\"America/Los_Angeles\"",
"\"America/Louisville\"",
"\"America/Lower_Princes\"",
"\"America/Maceio\"",
"\"America/Managua\"",
"\"America/Manaus\"",
"\"America/Marigot\"",
"\"America/Martinique\"",
"\"America/Matamoros\"",
"\"America/Mazatlan\"",
"\"America/Mendoza\"",
"\"America/Menominee\"",
"\"America/Merida\"",
"\"America/Metlakatla\"",
"\"America/Mexico_City\"",
"\"America/Miquelon\"",
"\"America/Moncton\"",
"\"America/Monterrey\"",
"\"America/Montevideo\"",
"\"America/Montreal\"",
"\"America/Montserrat\"",
"\"America/Nassau\"",
"\"America/New_York\"",
"\"America/Nipigon\"",
"\"America/Nome\"",
"\"America/Noronha\"",
"\"America/North_Dakota/Beulah\"",
"\"America/North_Dakota/Center\"",
"\"America/North_Dakota/New_Salem\"",
"\"America/Nuuk\"",
"\"America/Ojinaga\"",
"\"America/Panama\"",
"\"America/Pangnirtung\"",
"\"America/Paramaribo\"",
"\"America/Phoenix\"",
"\"America/Port-au-Prince\"",
"\"America/Port_of_Spain\"",
"\"America/Porto_Acre\"",
"\"America/Porto_Velho\"",
"\"America/Puerto_Rico\"",
"\"America/Punta_Arenas\"",
"\"America/Rainy_River\"",
"\"America/Rankin_Inlet\"",
"\"America/Recife\"",
"\"America/Regina\"",
"\"America/Resolute\"",
"\"America/Rio_Branco\"",
"\"America/Rosario\"",
"\"America/Santa_Isabel\"",
"\"America/Santarem\"",
"\"America/Santiago\"",
"\"America/Santo_Domingo\"",
"\"America/Sao_Paulo\"",
"\"America/Scoresbysund\"",
"\"America/Shiprock\"",
"\"America/Sitka\"",
"\"America/St_Barthelemy\"",
"\"America/St_Johns\"",
"\"America/St_Kitts\"",
"\"America/St_Lucia\"",
"\"America/St_Thomas\"",
"\"America/St_Vincent\"",
"\"America/Swift_Current\"",
"\"America/Tegucigalpa\"",
"\"America/Thule\"",
"\"America/Thunder_Bay\"",
"\"America/Tijuana\"",
"\"America/Toronto\"",
"\"America/Tortola\"",
"\"America/Vancouver\"",
"\"America/Virgin\"",
"\"America/Whitehorse\"",
"\"America/Winnipeg\"",
"\"America/Yakutat\"",
"\"America/Yellowknife\"",
"\"Antarctica/Casey\"",
"\"Antarctica/Davis\"",
"\"Antarctica/DumontDUrville\"",
"\"Antarctica/Macquarie\"",
"\"Antarctica/Mawson\"",
"\"Antarctica/McMurdo\"",
"\"Antarctica/Palmer\"",
"\"Antarctica/Rothera\"",
"\"Antarctica/South_Pole\"",
"\"Antarctica/Syowa\"",
"\"Antarctica/Troll\"",
"\"Antarctica/Vostok\"",
"\"Arctic/Longyearbyen\"",
"\"Asia/Aden\"",
"\"Asia/Almaty\"",
"\"Asia/Amman\"",
"\"Asia/Anadyr\"",
"\"Asia/Aqtau\"",
"\"Asia/Aqtobe\"",
"\"Asia/Ashgabat\"",
"\"Asia/Ashkhabad\"",
"\"Asia/Atyrau\"",
"\"Asia/Baghdad\"",
"\"Asia/Bahrain\"",
"\"Asia/Baku\"",
"\"Asia/Bangkok\"",
"\"Asia/Barnaul\"",
"\"Asia/Beirut\"",
"\"Asia/Bishkek\"",
"\"Asia/Brunei\"",
"\"Asia/Calcutta\"",
"\"Asia/Chita\"",
"\"Asia/Choibalsan\"",
"\"Asia/Chongqing\"",
"\"Asia/Chungking\"",
"\"Asia/Colombo\"",
"\"Asia/Dacca\"",
"\"Asia/Damascus\"",
"\"Asia/Dhaka\"",
"\"Asia/Dili\"",
"\"Asia/Dubai\"",
"\"Asia/Dushanbe\"",
"\"Asia/Famagusta\"",
"\"Asia/Gaza\"",
"\"Asia/Harbin\"",
"\"Asia/Hebron\"",
"\"Asia/Ho_Chi_Minh\"",
"\"Asia/Hong_Kong\"",
"\"Asia/Hovd\"",
"\"Asia/Irkutsk\"",
"\"Asia/Istanbul\"",
"\"Asia/Jakarta\"",
"\"Asia/Jayapura\"",
"\"Asia/Jerusalem\"",
"\"Asia/Kabul\"",
"\"Asia/Kamchatka\"",
"\"Asia/Karachi\"",
"\"Asia/Kashgar\"",
"\"Asia/Kathmandu\"",
"\"Asia/Katmandu\"",
"\"Asia/Khandyga\"",
"\"Asia/Kolkata\"",
"\"Asia/Krasnoyarsk\"",
"\"Asia/Kuala_Lumpur\"",
"\"Asia/Kuching\"",
"\"Asia/Kuwait\"",
"\"Asia/Macao\"",
"\"Asia/Macau\"",
"\"Asia/Magadan\"",
"\"Asia/Makassar\"",
"\"Asia/Manila\"",
"\"Asia/Muscat\"",
"\"Asia/Nicosia\"",
"\"Asia/Novokuznetsk\"",
"\"Asia/Novosibirsk\"",
"\"Asia/Omsk\"",
"\"Asia/Oral\"",
"\"Asia/Phnom_Penh\"",
"\"Asia/Pontianak\"",
"\"Asia/Pyongyang\"",
"\"Asia/Qatar\"",
"\"Asia/Qostanay\"",
"\"Asia/Qyzylorda\"",
"\"Asia/Rangoon\"",
"\"Asia/Riyadh\"",
"\"Asia/Saigon\"",
"\"Asia/Sakhalin\"",
"\"Asia/Samarkand\"",
"\"Asia/Seoul\"",
"\"Asia/Shanghai\"",
"\"Asia/Singapore\"",
"\"Asia/Srednekolymsk\"",
"\"Asia/Taipei\"",
"\"Asia/Tashkent\"",
"\"Asia/Tbilisi\"",
"\"Asia/Tehran\"",
"\"Asia/Tel_Aviv\"",
"\"Asia/Thimbu\"",
"\"Asia/Thimphu\"",
"\"Asia/Tokyo\"",
"\"Asia/Tomsk\"",
"\"Asia/Ujung_Pandang\"",
"\"Asia/Ulaanbaatar\"",
"\"Asia/Ulan_Bator\"",
"\"Asia/Urumqi\"",
"\"Asia/Ust-Nera\"",
"\"Asia/Vientiane\"",
"\"Asia/Vladivostok\"",
"\"Asia/Yakutsk\"",
"\"Asia/Yangon\"",
"\"Asia/Yekaterinburg\"",
"\"Asia/Yerevan\"",
"\"Atlantic/Azores\"",
"\"Atlantic/Bermuda\"",
"\"Atlantic/Canary\"",
"\"Atlantic/Cape_Verde\"",
"\"Atlantic/Faeroe\"",
"\"Atlantic/Faroe\"",
"\"Atlantic/Jan_Mayen\"",
"\"Atlantic/Madeira\"",
"\"Atlantic/Reykjavik\"",
"\"Atlantic/South_Georgia\"",
"\"Atlantic/St_Helena\"",
"\"Atlantic/Stanley\"",
"\"Australia/ACT\"",
"\"Australia/Adelaide\"",
"\"Australia/Brisbane\"",
"\"Australia/Broken_Hill\"",
"\"Australia/Canberra\"",
"\"Australia/Currie\"",
"\"Australia/Darwin\"",
"\"Australia/Eucla\"",
"\"Australia/Hobart\"",
"\"Australia/LHI\"",
"\"Australia/Lindeman\"",
"\"Australia/Lord_Howe\"",
"\"Australia/Melbourne\"",
"\"Australia/North\"",
"\"Australia/NSW\"",
"\"Australia/Perth\"",
"\"Australia/Queensland\"",
"\"Australia/South\"",
"\"Australia/Sydney\"",
"\"Australia/Tasmania\"",
"\"Australia/Victoria\"",
"\"Australia/West\"",
"\"Australia/Yancowinna\"",
"\"Brazil/Acre\"",
"\"Brazil/DeNoronha\"",
"\"Brazil/East\"",
"\"Brazil/West\"",
"\"Canada/Atlantic\"",
"\"Canada/Central\"",
"\"Canada/Eastern\"",
"\"Canada/Mountain\"",
"\"Canada/Newfoundland\"",
"\"Canada/Pacific\"",
"\"Canada/Saskatchewan\"",
"\"Canada/Yukon\"",
"\"CET\"",
"\"Chile/Continental\"",
"\"Chile/EasterIsland\"",
"\"CST6CDT\"",
"\"Cuba\"",
"\"EET\"",
"\"Egypt\"",
"\"Eire\"",
"\"EST\"",
"\"EST5EDT\"",
"\"Etc/GMT\"",
"\"Etc/GMT+0\"",
"\"Etc/GMT+1\"",
"\"Etc/GMT+10\"",
"\"Etc/GMT+11\"",
"\"Etc/GMT+12\"",
"\"Etc/GMT+2\"",
"\"Etc/GMT+3\"",
"\"Etc/GMT+4\"",
"\"Etc/GMT+5\"",
"\"Etc/GMT+6\"",
"\"Etc/GMT+7\"",
"\"Etc/GMT+8\"",
"\"Etc/GMT+9\"",
"\"Etc/GMT-0\"",
"\"Etc/GMT-1\"",
"\"Etc/GMT-10\"",
"\"Etc/GMT-11\"",
"\"Etc/GMT-12\"",
"\"Etc/GMT-13\"",
"\"Etc/GMT-14\"",
"\"Etc/GMT-2\"",
"\"Etc/GMT-3\"",
"\"Etc/GMT-4\"",
"\"Etc/GMT-5\"",
"\"Etc/GMT-6\"",
"\"Etc/GMT-7\"",
"\"Etc/GMT-8\"",
"\"Etc/GMT-9\"",
"\"Etc/GMT0\"",
"\"Etc/Greenwich\"",
"\"Etc/UCT\"",
"\"Etc/Universal\"",
"\"Etc/UTC\"",
"\"Etc/Zulu\"",
"\"Europe/Amsterdam\"",
"\"Europe/Andorra\"",
"\"Europe/Astrakhan\"",
"\"Europe/Athens\"",
"\"Europe/Belfast\"",
"\"Europe/Belgrade\"",
"\"Europe/Berlin\"",
"\"Europe/Bratislava\"",
"\"Europe/Brussels\"",
"\"Europe/Bucharest\"",
"\"Europe/Budapest\"",
"\"Europe/Busingen\"",
"\"Europe/Chisinau\"",
"\"Europe/Copenhagen\"",
"\"Europe/Dublin\"",
"\"Europe/Gibraltar\"",
"\"Europe/Guernsey\"",
"\"Europe/Helsinki\"",
"\"Europe/Isle_of_Man\"",
"\"Europe/Istanbul\"",
"\"Europe/Jersey\"",
"\"Europe/Kaliningrad\"",
"\"Europe/Kiev\"",
"\"Europe/Kirov\"",
"\"Europe/Lisbon\"",
"\"Europe/Ljubljana\"",
"\"Europe/London\"",
"\"Europe/Luxembourg\"",
"\"Europe/Madrid\"",
"\"Europe/Malta\"",
"\"Europe/Mariehamn\"",
"\"Europe/Minsk\"",
"\"Europe/Monaco\"",
"\"Europe/Moscow\"",
"\"Europe/Nicosia\"",
"\"Europe/Oslo\"",
"\"Europe/Paris\"",
"\"Europe/Podgorica\"",
"\"Europe/Prague\"",
"\"Europe/Riga\"",
"\"Europe/Rome\"",
"\"Europe/Samara\"",
"\"Europe/San_Marino\"",
"\"Europe/Sarajevo\"",
"\"Europe/Saratov\"",
"\"Europe/Simferopol\"",
"\"Europe/Skopje\"",
"\"Europe/Sofia\"",
"\"Europe/Stockholm\"",
"\"Europe/Tallinn\"",
"\"Europe/Tirane\"",
"\"Europe/Tiraspol\"",
"\"Europe/Ulyanovsk\"",
"\"Europe/Uzhgorod\"",
"\"Europe/Vaduz\"",
"\"Europe/Vatican\"",
"\"Europe/Vienna\"",
"\"Europe/Vilnius\"",
"\"Europe/Volgograd\"",
"\"Europe/Warsaw\"",
"\"Europe/Zagreb\"",
"\"Europe/Zaporozhye\"",
"\"Europe/Zurich\"",
"\"Factory\"",
"\"GB\"",
"\"GB-Eire\"",
"\"GMT\"",
"\"GMT+0\"",
"\"GMT-0\"",
"\"GMT0\"",
"\"Greenwich\"",
"\"Hongkong\"",
"\"HST\"",
"\"Iceland\"",
"\"Indian/Antananarivo\"",
"\"Indian/Chagos\"",
"\"Indian/Christmas\"",
"\"Indian/Cocos\"",
"\"Indian/Comoro\"",
"\"Indian/Kerguelen\"",
"\"Indian/Mahe\"",
"\"Indian/Maldives\"",
"\"Indian/Mauritius\"",
"\"Indian/Mayotte\"",
"\"Indian/Reunion\"",
"\"Iran\"",
"\"Israel\"",
"\"Jamaica\"",
"\"Japan\"",
"\"Kwajalein\"",
"\"Libya\"",
"\"MET\"",
"\"Mexico/BajaNorte\"",
"\"Mexico/BajaSur\"",
"\"Mexico/General\"",
"\"MST\"",
"\"MST7MDT\"",
"\"Navajo\"",
"\"NZ\"",
"\"NZ-CHAT\"",
"\"Pacific/Apia\"",
"\"Pacific/Auckland\"",
"\"Pacific/Bougainville\"",
"\"Pacific/Chatham\"",
"\"Pacific/Chuuk\"",
"\"Pacific/Easter\"",
"\"Pacific/Efate\"",
"\"Pacific/Enderbury\"",
"\"Pacific/Fakaofo\"",
"\"Pacific/Fiji\"",
"\"Pacific/Funafuti\"",
"\"Pacific/Galapagos\"",
"\"Pacific/Gambier\"",
"\"Pacific/Guadalcanal\"",
"\"Pacific/Guam\"",
"\"Pacific/Honolulu\"",
"\"Pacific/Johnston\"",
"\"Pacific/Kanton\"",
"\"Pacific/Kiritimati\"",
"\"Pacific/Kosrae\"",
"\"Pacific/Kwajalein\"",
"\"Pacific/Majuro\"",
"\"Pacific/Marquesas\"",
"\"Pacific/Midway\"",
"\"Pacific/Nauru\"",
"\"Pacific/Niue\"",
"\"Pacific/Norfolk\"",
"\"Pacific/Noumea\"",
"\"Pacific/Pago_Pago\"",
"\"Pacific/Palau\"",
"\"Pacific/Pitcairn\"",
"\"Pacific/Pohnpei\"",
"\"Pacific/Ponape\"",
"\"Pacific/Port_Moresby\"",
"\"Pacific/Rarotonga\"",
"\"Pacific/Saipan\"",
"\"Pacific/Samoa\"",
"\"Pacific/Tahiti\"",
"\"Pacific/Tarawa\"",
"\"Pacific/Tongatapu\"",
"\"Pacific/Truk\"",
"\"Pacific/Wake\"",
"\"Pacific/Wallis\"",
"\"Pacific/Yap\"",
"\"Poland\"",
"\"Portugal\"",
"\"PRC\"",
"\"PST8PDT\"",
"\"ROC\"",
"\"ROK\"",
"\"Singapore\"",
"\"Turkey\"",
"\"UCT\"",
"\"Universal\"",
"\"US/Alaska\"",
"\"US/Aleutian\"",
"\"US/Arizona\"",
"\"US/Central\"",
"\"US/East-Indiana\"",
"\"US/Eastern\"",
"\"US/Hawaii\"",
"\"US/Indiana-Starke\"",
"\"US/Michigan\"",
"\"US/Mountain\"",
"\"US/Pacific\"",
"\"US/Samoa\"",
"\"UTC\"",
"\"W-SU\"",
"\"WET\"",
"\"Zulu\""
]
Default"America/Los_Angeles"
ExampleAmerica/Los_Angeles
filter
Array of string
A filter requires an array with 3 specific string values: ["Cthulu Prefix", "EO Field Key", "EO Field Value"]
Max items3
Default[
"eq",
"name",
"PURCHASE"
]
Example[
"eq",
"name",
"PURCHASE"
]
string
response_format
string
Format of returned data. json or csv
Valid values[
"\"csv\"",
"\"json\""
]
Default"csv"
allow_multiple_files
boolean
Set this parameter to true if you want more than 2 million records returned.
response_format_compression
The file compression method to use for the data.
Required if allow_multiple_files is set to true.
Valid values[
"\"gz\"",
"\"snappy\""
]
Responses
200
Status of aggregate export
Result
"{\n \"handle\": \"xxxx-0000\",\n \"export_job_status_url\": \"https://api2.branch.io/v2/logs/{UNIQUE_ALPHANUMERICAL_JOB_HANDLE_ID_HERE}?app_id={APP_ID_HERE}\"\n}\n"object
handle
string
Unique request handle generated against the endpoint call.
Examplexxxx-0000
export_job_status_url
string
The URL of the export request.
Examplehttps://api2.branch.io/v2/logs/{UNIQUE_ALPHANUMERICAL_JOB_HANDLE_ID_HERE}?app_id={APP_ID_HERE}
401
Auth Client failed response
Result
"{\n \"error\": {\n \"message\": \"Auth Client didn't return anything for the user id: $userid.\",\n \"code\": 401\n }\n}"object
error
object (inline_response_401_error)
message
string
ExampleAuth Client failed response
code
integer
Example401
404
User Not Found
Result
"{\n \"error\": {\n \"message\": \"Not authorized for the user id: $userid.\",\n \"code\": 404\n }\n}"object
error
object (inline_response_404_error)
message
string
ExampleUser Not Found
code
integer
Example404
500
Internal Server Error
Result
"{\n \"error\": {\n \"message\": \"Our product is failing to serve your request at this moment. Please try again later.\",\n \"code\": 500\n }\n}"object
error
object (inline_response_500_error)
message
string
ExampleInternal Server Error
code
integer
Example500