Post
/branch_aggregate/async/analytics
Initiate an export of your aggregate Branch data.
Security
API Key
Query parameter nameapp_id
app_id | Unique identifier for Branch app of requested data.
API Key
Header parameter nameAccess-Token
Key that encapsulates the user's permission with regards to an organization. Obtained from the Branch Dashboard and needed for authentication.
Body parameters
object
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
dimensions
Array of string
An array representing dimension(s) to group by. See dimensions section for more.
Example[
"user_data_os"
]
string
Valid values[
"link_alias",
"link_archived",
"link_creation_source",
"link_dollar_sign_3p",
"link_dollar_sign_android_deeplink_path",
"link_dollar_sign_android_deepview",
"link_dollar_sign_android_passive_deepview",
"link_dollar_sign_android_url",
"link_dollar_sign_canonical_identifier",
"link_dollar_sign_canonical_url",
"link_dollar_sign_deeplink_path",
"link_dollar_sign_desktop_deeplink_path",
"link_dollar_sign_desktop_deepview",
"link_dollar_sign_desktop_passive_deepview",
"link_dollar_sign_desktop_url",
"link_dollar_sign_fallback_url",
"link_dollar_sign_ios_deeplink_path",
"link_dollar_sign_ios_deepview",
"link_dollar_sign_ios_passive_deepview",
"link_dollar_sign_ios_url",
"link_dollar_sign_marketing_title",
"link_dollar_sign_og_description",
"link_dollar_sign_og_image_url",
"link_dollar_sign_og_title",
"link_dollar_sign_og_type",
"link_dollar_sign_og_url",
"link_dollar_sign_uri_redirect_mode",
"link_dollar_sign_web_only",
"link_domain",
"link_id",
"link_tilde_campaign",
"link_tilde_channel",
"link_tilde_feature",
"link_tilde_quick_link_template_id",
"link_tilde_tags",
"link_type",
"last_op",
"name",
"origin",
"deep_linked",
"from_desktop",
"attributed",
"user_data_app_store",
"user_data_app_version",
"user_data_os",
"user_data_language",
"user_data_platform",
"user_data_environment",
"user_data_geo_dma_code",
"user_data_geo_country_code",
"user_data_country",
"user_data_geo_region_en",
"user_data_opted_in",
"user_data_opted_in_status",
"last_attributed_touch_type",
"last_attributed_touch_data_tilde_tags",
"last_attributed_touch_data_tilde_secondary_publisher",
"last_attributed_touch_data_tilde_campaign",
"last_attributed_touch_data_tilde_advertising_partner_name",
"last_attributed_touch_data_tilde_advertising_partner_id",
"last_attributed_touch_data_tilde_feature",
"last_attributed_touch_data_tilde_creative_name",
"last_attributed_touch_data_tilde_creative_id",
"last_attributed_touch_data_tilde_ad_name",
"last_attributed_touch_data_tilde_ad_id",
"last_attributed_touch_data_tilde_campaign_id",
"last_attributed_touch_data_tilde_placement",
"last_attributed_touch_data_tilde_stage",
"last_attributed_touch_data_tilde_channel",
"last_attributed_touch_data_tilde_ad_set_name",
"last_attributed_touch_data_tilde_ad_set_id",
"last_attributed_touch_data_tilde_keyword",
"last_attributed_touch_data_tilde_keyword_id",
"last_attributed_touch_data_tilde_journey_id",
"last_attributed_touch_data_tilde_view_name",
"last_attributed_touch_data_tilde_view_id",
"last_attributed_touch_data_tilde_agency",
"last_attributed_touch_data_tilde_agency_id",
"last_attributed_touch_data_tilde_customer_secondary_publisher",
"last_attributed_touch_data_tilde_customer_ad_set_name",
"last_attributed_touch_data_tilde_customer_ad_name",
"last_attributed_touch_data_tilde_customer_keyword",
"last_attributed_touch_data_tilde_customer_placement",
"last_attributed_touch_data_tilde_customer_sub_site_name",
"last_attributed_touch_data_tilde_customer_campaign",
"last_attributed_touch_data_plus_web_format",
"last_attributed_touch_data_plus_current_feature",
"last_attributed_touch_data_plus_via_features",
"last_attributed_touch_data_dollar_marketing_title",
"last_attributed_touch_data_dollar_3p",
"last_cta_view_data_tilde_ad_name",
"last_cta_view_data_tilde_secondary_publisher",
"last_cta_view_data_tilde_campaign",
"last_cta_view_data_tilde_advertising_partner_name",
"last_cta_view_data_tilde_feature",
"last_cta_view_data_tilde_ad_set_name",
"last_cta_view_data_tilde_ad_set_id",
"last_cta_view_data_tilde_campaign_id",
"last_cta_view_data_tilde_creative_name",
"last_cta_view_data_tilde_creative_id",
"last_cta_view_data_plus_via_features",
"last_cta_view_data_dollar_3p",
"last_cta_view_data_tilde_tags",
"last_cta_view_data_plus_web_format",
"last_cta_view_data_tilde_channel",
"last_cta_view_data_tilde_ad_id",
"last_cta_view_data_tilde_stage",
"body_ad_network_id",
"body_campaign_id",
"body_app_id",
"body_redownload",
"body_source_app_id",
"body_conversion_value",
"body_last_attributed_touch_data_tilde_creative_name",
"body_last_attributed_touch_data_tilde_ad_set_name",
"body_last_attributed_touch_data_tilde_creative_id",
"body_last_attributed_touch_data_tilde_ad_set_id",
"body_last_attributed_touch_data_tilde_ad_name",
"body_last_attributed_touch_data_tilde_ad_id",
"body_last_attributed_touch_data_tilde_campaign",
"body_last_attributed_touch_data_tilde_campaign_id",
"body_last_attributed_touch_data_tilde_campaign_name",
"annotation_dollar_3p",
"annotation_conversion_value_mapped_value",
"annotation_conversion_value_revision",
"annotation_campaign_id_mapped_value",
"annotation_campaign_id_revision",
"annotation_source_app_id_mapped_value",
"annotation_source_app_id_revision",
"annotation_customer_event_alias",
"days_from_last_attributed_touch_to_event",
"days_from_last_cta_view_to_event",
"event_data_product_categories",
"event_data_custom_param_1",
"event_data_custom_param_2",
"event_data_custom_param_3",
"first_event_for_user",
"customer_event_alias"
]
filter
object
An object representing a filter, or multiple filters. See filter examples.
Example{
"type": "in",
"dimension": "name",
"values": [
"x",
"y"
]
}
granularity
string
The time granularity that each band value will represent.
Valid values[
"day",
"week",
"month",
"all"
]
Default"all"
limit_sort_spec
object
An object describing column/row ordering and limiting. See schema.
Example{
"sort_columns": []
}
aggregations
Array of object
An array where each element is an aggregation object. Aggregation object requires field name, display name, and data source. See schema and more.
Example[
{
"field_name": "sketch_unique_count",
"display_name": "unique_lifecycle_events_count",
"data_source": "eo_user_lifecycle_event"
},
{
"field_name": "total_count",
"display_name": "eo_click",
"data_source": "eo_click"
}
]
object
response_format_compression
string
Compression method to use for data file.
Valid values[
"snappy",
"gz"
]
Default"snappy"
response_format
string
Compression format to use for data file.
Valid values[
"parquet",
"csv",
"json"
]
Default"parquet"
Responses
200
Success
Result
"{\n \"code\": 200,\n \"job_id\": \"XXXX-0000-xxxx\",\n \"status_url\": \"https://api2.branch.io/v1/branch_aggregate/async/status/{JOB_ID_HERE}\"\n}"object
code
integer
Example200
job_id
string
The unique ID of the request.
ExampleXXXX-0000-xxxx
status_url
string
The URL of the export request.
Examplehttps://api2.branch.io/v1/branch_aggregate/async/status/{JOB_ID_HERE}
400
Authentication Failed
Result
"{\n \"error\": {\n \"message\": \"Authentication failed !\",\n \"code\": 400\n }\n}"object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400