If you're experiencing issues with rate limits in the Branch data source connector, or if there are discrepancies in your data, there are some things you can do to work around them.
Low rate limits
Our Branch data source connector has rate limits that affect the granularity of the provided data. Heavy usage of the data source connector may also cause rate limit errors.
The API rate limits are tied to your own Branch account. The standard limits set by Branch are currently:
5 requests per second
20 requests per minute
150 requests per hour
Each metric included in a Supermetrics query will consume 1 request, and each week of time range will also consume 1 request.
Due to this, select the metrics and time range in your queries carefully, or you may see a rate limit error when using the connector.
If these rate limits are too low for your use case, consider reaching out to your Branch account manager for assistance in increasing your limits.
Query sizing to stay within rate limits
The Branch Query API allows only 1 metric and a date range of up to 7 days per request. Because of this, Supermetrics splits every query into multiple requests based on the date range, the number of metrics, and the number of accounts you select.
All of these requests count against Branch's rate limit of 150 requests per hour. This quota applies to your account. If you go over it, Branch returns a 429 error stating that the limit is exceeded for the account. You can't work around this by changing your query or retrying, since Branch enforces the quota on its end.
To finish a query in a single run, keep your total number of requests at or below 150. The table below shows the maximum date range you can query in one run, assuming a single account and no additional breakdowns:
Metrics selected | Max date range |
|---|---|
1 | About 1,050 days (about 2.9 years) |
2 | About 525 days (about 1.4 years) |
3 | About 350 days (about 11.5 months) |
4 | About 260 days (about 8.5 months) |
5 | About 210 days (about 7 months) |
Querying multiple accounts at once further reduces this maximum range, since your accounts share the same 150-requests-per-hour quota. Here's an example with 3 metrics selected:
Accounts | Max date range |
|---|---|
1 | About 350 days |
3 | About 112 days |
5 | About 70 days |
These figures are upper bounds. If your query includes breakdowns with many unique combinations, such as campaign, channel, and platform together, the connector may need additional requests, which further reduces the maximum range.
To pull more historical data than a single run allows, split the date range across multiple runs, or reduce the number of metrics or accounts in your query.
If you need larger date ranges in a single run, contact your Branch account manager to request higher rate limits.
Country data
In Branch, there are two country-related dimensions:
The Country dimension is determined by the user's IP address.
The Country code dimension is manually set by the user.
If you encounter discrepancies while fetching data using the Country dimension, try running a query using the Country code dimension, and vice versa.
Discrepancies
The Branch dashboard UI has 2 checkbox options for filtering data (Organic and Unique) as well as its own data filtering algorithm that the user can't control.
However, the Branch Query API returns raw data and does not use the same options. This can cause discrepancies when comparing data from the native Branch UI with data from the Supermetrics data source connector.
To align the data source connector's results more closely with the Branch UI, you can apply specific settings during the query setup according to the table below. Please note that even with the applied filters, a 5-10% discrepancy is expected.
Branch: Summary dashboard setting | Supermetrics: Query type | Supermetrics: FilterNone |
|---|---|---|
None | Summary (total) | Views and Page views metrics:
Standard, commerce, content, lifecycle, and custom metrics (excluding Views and Page views):
Cost and revenue metrics:
|
Organic | Summary (total) | Views and Page views metrics:
Standard, commerce, content, lifecycle, and custom metrics (excluding Views and Page views):
Cost and revenue metrics:
|
Unique * Daily split must be selected in the UI dashboard for the data to match | Summary (unique) | Views and Page views metrics:
Standard, commerce, content, lifecycle, and custom metrics (excluding Views and Page views):
Cost and revenue:
|
Organic & Unique * Daily split must be selected in the UI dashboard for the data to match | Summary (unique) | Filter for all metrics:
Cost and revenue:
|