> ## Documentation Index
> Fetch the complete documentation index at: https://help.airbridge.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom GroupBy Manager

Custom GroupBys reclassify basic GroupBy values by criteria you define, so you can view their performance in one place. For example, suppose you ran a summer promotion in the US and Canada and named its campaigns and ad creatives with `summer` or `été`. With basic GroupBys alone, you need to view **Campaign** and **Ad Creative** separately with a `summer` filter and an `été` filter, download the results, and combine them. Instead, create a `Summer Promotion` custom GroupBy that groups every campaign and ad creative whose name contains `summer` or `été`, and view the whole promotion with that one GroupBy.

![Actuals report preview showing Canada Promotion and US Promotion performance with the Summer Promotion custom GroupBy](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-summer-promotion-preview.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=4a7b339b753c903fccfd7417de5025af)

> [!NOTE]
>
> **Note**
>
> * Custom GroupBys are shared across your organization and available in all of its apps. However, Owners and In-house Marketers cannot see custom GroupBys created by agencies, and each agency sees only its own.
> * Custom GroupBys are available in the Actuals report, the Trend report, and the Overview dashboard.

## Create custom GroupBys

To create a custom GroupBy, set rules that classify basic GroupBy values into custom GroupBy values. As you go through each step, you can check the results in the preview.

> [!NOTE]
>
> **Check the results in the Actuals report preview**
>
> * To run the preview, complete the custom GroupBy value you're editing.
> * The preview shows only basic GroupBy values that match a custom GroupBy value. Unmatched values aren’t displayed.

### Enter details

1. In the Airbridge dashboard, go to **\[Management]>\[Custom GroupBy Manager]** and click **Create GroupBy**.
2. Enter a name for the GroupBy. The name must be unique and can be up to 128 characters.
3. Optionally, enter a description of up to 500 characters and an example of up to 100 characters.
4. Click **Next**.

In reports, the name appears in the GroupBy list, and hovering over it shows the description and example. Check how they look in the **\[Preview]** panel on the right.

![Details step with the GroupBy name, description, and example, and the Preview panel on the right](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-create-details.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=40b337c876be1efce9975d91582db689)

### Set rules

1. Name the custom GroupBy value as you want it to appear in reports, using up to 50 characters. Values are the items within a GroupBy, such as `facebook.business`, `tiktok`, and `ironsource` in the **Channel** GroupBy.

![Rules step with rules set for the Canada Promotion and US Promotion custom GroupBy values](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-create-rules.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=9ce622f63c69b36a6d856a76c94ce65d)

2. Set a rule for the custom GroupBy value by selecting a basic GroupBy, a match type, and values.

> **Basic GroupBys**
>
> Basic GroupBys are the GroupBys available in the Actuals report. You cannot select an existing custom GroupBy as a basic GroupBy. A custom GroupBy can use up to two basic GroupBys. Once you select two, the other custom GroupBy values can use only those two.

> **Match types**
>
> There are two match types, **is** and **contains**.
>
> | Match type | Description |
> | - | - |
> | **is** | Matches only when the basic GroupBy value exactly matches the value you enter. Example: Classify the campaigns `summer_sale_ca` and `ete_promo_qc` as the custom GroupBy value `Canada Promotion`. |
> | **contains** | Matches when the basic GroupBy value contains the keyword you enter. Example: Classify campaigns whose names contain `été` as the custom GroupBy value `Canada Promotion`. |
>
> * Both match types are case-sensitive and treat spaces and commas as part of the value.
> * If a rule has multiple values or keywords, matching any one of them satisfies the rule.

> **Match priority**
>
> The same value can appear in the rules of multiple custom GroupBy values. When a basic GroupBy value matches more than one, it's classified only as the one with the highest priority. For example, if the custom GroupBy value `Canada Promotion` is above `US Promotion`, the campaign `summer_été_sale`, whose name contains both `été` and `summer`, is classified as `Canada Promotion`. To change the priority of custom GroupBy values, drag them in **\[Match priority]** on the right.
>
> A custom GroupBy value doesn't appear in reports if all of its matching values are already classified as higher-priority custom GroupBy values.

3. Select how to show basic GroupBy values that don't match any custom GroupBy value.

| Option | Description |
| - | - |
| Keep original values | · Shows each unmatched value as collected. · Selected by default · Empty original values appear blank. |
| Combine into a new custom GroupBy value | · Combines all unmatched values into one custom GroupBy value with the name you enter. · The name can be up to 50 characters. |

> [!NOTE]
>
> **When Keep original values isn't available**
>
> * Any custom GroupBy value has two rules
> * The custom GroupBy uses two basic GroupBys, even if each custom GroupBy value uses a different one

4. To add a rule, click **Add rule** and select **AND** or **OR**. Each custom GroupBy value can have up to two rules.

> **AND and OR**
>
> When a custom GroupBy value has two rules, AND or OR combines them. Neither rule takes priority over the other.
>
> | Operator | Description |
> | - | - |
> | AND | Matches only values that satisfy both rules. For example, a value is classified as `Canada Promotion` only when both **Campaign** and **Ad Creative** contain `été`. |
> | OR | Matches values that satisfy either rule. For example, a value is classified as `Canada Promotion` when **Campaign** or **Ad Creative** contains `été`. |
>
> ![Canada Promotion custom GroupBy value with Campaign and Ad Creative rules joined by OR](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-rule-and-or.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=d2c4339e520941e32c0a2bb5b28e47d1)

5. To add more custom GroupBy values, click **Add custom GroupBy value** and repeat from step 1. A custom GroupBy can have up to 12 custom GroupBy values.

### Review the custom GroupBy

1. In **\[Review]**, check the GroupBy name, description, custom GroupBy values and rules, and unmatched values. To make changes, click **Edit** on the item to return to its step.
2. To view the results with the custom GroupBy applied, click **Run**.
3. Click **Save**.

Saved custom GroupBys appear in the **\[Custom GroupBy Manager]** list.

![Review step showing the GroupBy info, custom GroupBy values and rules, and unmatched values](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-create-review.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=d11824e22994f6abeab6dacbdc897480)

## Manage custom GroupBys

In the Airbridge dashboard, go to **\[Management]>\[Custom GroupBy Manager]** to view and manage custom GroupBys. Search the list by custom GroupBy name or key. The custom GroupBy list has the following columns:

| Column | Description |
| - | - |
| **GroupBy Info** | · The GroupBy's name, its custom GroupBy values, and the rules for each custom GroupBy value · Click the name to expand its custom GroupBy values and rules. |
| **GroupBy Key** | · This string identifies the GroupBy when you request reports via API. Airbridge generates it automatically. · Click the key to copy it. |
| **Action** | To edit, duplicate, or delete the custom GroupBy, click the more icon (⋯). |

> [!CAUTION]
>
> **Attention**
>
> Deleted custom GroupBys cannot be restored. Saved reports that used a deleted custom GroupBy can no longer use it.

![Custom GroupBy Manager list with the GroupBy Info, GroupBy Key, and Action columns](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-manager-list.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=c7413c51d70011fa0d232200f8e3df20)

## Use custom GroupBys in reports

Use your saved custom GroupBys in the Actuals report, the Trend report, and the Overview dashboard. In the Airbridge dashboard, find them in the following locations:

| Report | GroupBy location |
| - | - |
| · Actuals report · Trend report | The **\[Custom]** tab under **\[GroupBys]** in the report settings |
| Overview dashboard | The **\[Custom]** tab under **\[GroupBy]** in the table |

![Custom tab open in the GroupBy selector of the report settings](https://mintcdn.com/airbridge-help-center/XATFlhQDXNtSYTw_/asset/image/custom-groupby-report-groupby-selector.png?fit=max\&auto=format\&n=XATFlhQDXNtSYTw_\&q=85\&s=3fbea35ee58c3b6926c78c22952b1146)

## Custom GroupBy features and limits

Custom GroupBys have the following features and limits.

| Category | Description |
| - | - |
| Sharing scope | · All apps in your organization · Owners and In-house Marketers cannot see custom GroupBys created by agencies, and each agency sees only its own. |
| Supported reports | · Actuals report · Trend report · Overview dashboard |
| CSV files and Sharelinks | Supported |
| Raw data export | Not supported |
| Selectable basic GroupBys | · Basic GroupBys available in the Actuals report · Other custom GroupBys cannot be selected. |
| Basic GroupBys per custom GroupBy | Up to 2 |
| Custom GroupBy values per custom GroupBy | Up to 12 |
| Rules per custom GroupBy value | Up to 2 |
| Values or keywords per rule | Up to 10 |
| Custom GroupBys per organization | Up to 300 |
| GroupBy name | Up to 128 characters |
| GroupBy description | Up to 500 characters |
| GroupBy example | Up to 100 characters |
| Custom GroupBy value name | Up to 50 characters |
| Custom GroupBys your Airbridge CSM created on request | Only Owners and In-house Marketers can continue to use them in reports. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.