Cohort API

The Cohort API lets you programmatically query and export Cohort analytics.

Read the Cohort API overview

Get export download status

GET/analytics/{job_id}

This endpoint provisions querying and exporting Cohort analytics.

Parameters

app_idstringqueryRequired
Unique identifier for the Branch app of the requested data. Either appId or organization_id is required.
job_idstringpathRequired
Unique identifier for the job. Obtained from the POST Export Cohort analytics API.
formatenumquery
Format of the returned data: json or csv.
csvjson

Returns

Status of aggregate export. Returns 400 and 429 on failure — see the response panel for the error shape.

app_id*job_id*formatAccess-Token*

curl 'https://api2.branch.io/v2/analytics/0000-XXxx?app_id=123456789012345680' \
  --request GET \
  --header 'Access-Token: <Access-Token>'

Response

Status of aggregate export.

{
  "status": "FINISHED",
  "code": 200,
  "response_url": "https://api2.branch.io/v2/analytics/a1b2c3d4",
  "error_message": "N/A"
}

Export Cohort analytics

POST/analytics

This endpoint provisions querying and exporting Cohort analytics.

Parameters

app_idstringqueryRequired
Unique identifier for the Branch app of the requested data. Either appId or organization_id is required.
data_sourceenumRequired
A string value representing the cohort type.
install_cohortreengagement_cohort
end_datestringRequired
The end of the interval time range represented as an ISO-8601 complete date.
granularity_band_countintegerRequired
Number of time units since the cohort event to return to the user.
measuresarray of enumRequired
The cohort measures to return. The limit is 3. See Measure for the complete list.
OPENusersRetentionARPPULTVARPUrevenuePURCHASEADD_TO_CARTADD_TO_WISHLISTVIEW_CARTINITIATE_PURCHASE
start_datestringRequired
The start of the interval time range represented as an ISO-8601 complete date.
cumulativeboolean
If true, sum across bands so that a given band value is the sum of all preceding values plus the band value.
dimensionsarray of enum
An array representing the dimensions to group by. The limit is 11. See Dimensions for the complete list.
install_activity_attributedinstall_activity_event_nameinstall_activity_touch_typeinstall_activity_touch_data_tilde_campaign_idinstall_activity_touch_data_tilde_campaigninstall_activity_touch_data_tilde_channelinstall_activity_touch_data_tilde_featureinstall_activity_touch_data_tilde_stageinstall_activity_touch_data_tilde_tagsinstall_activity_touch_data_tilde_advertising_partner_nameinstall_activity_touch_data_dollar_3pinstall_activity_touch_data_tilde_secondary_publisher

More parameters

enable_install_recalculationboolean
filterobject
formatenumquery
granularityenum
limitintegerquery
orderedenum
ordered_byenum
per_userboolean
uniqueboolean

Returns

Status of aggregate export. Returns 400 and 429 on failure — see the response panel for the error shape.

app_id*limitformatAccess-Token*

curl 'https://api2.branch.io/v2/analytics?app_id=123456789012345680' \
  --request POST \
  --header 'Access-Token: <Access-Token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "start_date": "2023-05-15",
    "end_date": "2023-05-16",
    "data_source": "install_cohort",
    "measures": [
      "OPEN"
    ],
    "granularity_band_count": 7,
    "dimensions": [
      "install_activity_touch_data_tilde_campaign"
    ],
    "filter": {
      "install_activity_touch_data_tilde_campaign": [
        "A4G"
      ]
    },
    "ordered": "descending",
    "ordered_by": "install_activity_touch_data_tilde_campaign",
    "granularity": "day",
    "enable_install_recalculation": true
  }'

Response

Status of aggregate export.

{
  "job_id": "0000-XXxx",
  "code": 200,
  "status_url": "https://api2.branch.io/v2/analytics/a1b2c3d4",
  "error_message": "N/A"
}

Cohort API

Get export download status

Parameters

Returns

Export Cohort analytics

Parameters

More parameters Expand all

Returns

More parameters