# Welcome to Ingest Labs Documentation

This documentation portal explains how to ingest, manage, orchestrate, and onboard Ingest Labs on to your website.

* [Navigating through UI](/navigation/navigating-through-ui)
* [Tag Manager](/tag-manager/introduction)
* [Media Data Platform](/media-data-platform/about-media-data-platform)
* [Site Performance](/site-performance/about-site-performance)


# Shopify


# Shopify Onboarding Guide

## Introduction

This document provides detailed instructions to help customers onboard with **Ingest Labs** Shopify app through the **Shopify App Store**.

## Procedure

**Step 1:** Open a web browser and go to the following Shopify App Store link: <https://admin.shopify.com/store/f02tna-vi>

**Step 2:** Open a web browser and navigate to the following Shopify App Store link: <https://apps.shopify.com/server-side-tag-manager>

**Step 3:** You will see the **Ingest Labs** app listed as **Server-Side Tag Manager**. Click **Install** to begin the installation process.

<figure><img src="/files/p8SKdvQVIaZEyyDaYii6" alt=""><figcaption></figcaption></figure>

**Step 4:** You will be redirected to the Shopify home page, and the **Ingest Labs** installation window will open. Click **Install** to proceed with the app setup.

<figure><img src="/files/rMBpi4ZIkUc6L5sAzSwr" alt=""><figcaption></figcaption></figure>

**Step 5**: **Welcome to Ingest Labs** page will open. Your **email** and **password** will be pre-filled on the login screen. Click **Login** to access your Ingest Labs account.

<figure><img src="/files/ftr5xMiV3sKa2Gio15Uy" alt=""><figcaption></figcaption></figure>

**Step 6:** The **Select an existing Organization** page will open. In the **Select an organization** dropdown, you will see a list of available organizations. From the dropdown, select **Ketch**. Click **Proceed** to continue.

**Step 7:** The **Domain DNS Mapping** screen will open. Click **Initiate Onboarding** to begin the onboarding process.

**Step 8:**&#x20;


# Navigating Through UI

This section explains the different tabs available on the Ingest Labs UI screen.

After signing in, the landing page appears, displaying the **Vendor Name** <img src="/files/TpPMqt5eI1IVTW7GLozr" alt="" data-size="line"> at the top and the **Username** <img src="/files/qTpkaaetJPa3AEUqQsCm" alt="" data-size="line">along with the **Email ID** of the signed-in customer at the bottom left.

<figure><img src="/files/rkpzUbAz0auTc4FIPmCl" alt=""><figcaption></figcaption></figure>

Click the **User Icon** to edit the profile or log out of the application.

<figure><img src="/files/ZCZ7bAfBrdh5K0pbyPq9" alt=""><figcaption></figcaption></figure>

### Products <a href="#products" id="products"></a>

The **Products** section includes the list of products available for a particular Ingest Labs project.

<figure><img src="/files/wCZm4Q4eqFgFVEL140WC" alt=""><figcaption></figcaption></figure>

#### **Notification Groups**

A **Notification Group** allows you to add multiple email addresses to receive alerts for alarms and product updates. Notifications are set at the client level, ensuring that only the relevant people receive alerts at the right time.

<figure><img src="/files/TFrBImKpee0B8naM58hX" alt=""><figcaption></figcaption></figure>

### Info <a href="#info" id="info"></a>

The **Info** section displays the information related to the product.

![info](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/info.png)

### Users <a href="#users" id="users"></a>

The **Users** section displays the number of users accessing the Ingest Labs product and the roles allocated for a particular user.

#### Add a New User <a href="#addanewuser" id="addanewuser"></a>

To add a new user, perform the following steps:

1. Click **Users**.
2. Click **Add User** on the top-right corner of the screen.

![addanewuser](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/adduser.png)

3. Enter the e-mail in the **E-mail** field.
4. Enter the Full Name in the **Full Name** field.
5. Enter the Last name in the **Last Name** field.<br>

![adduser](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/mandatoryuserinfo.png)

**Note**: Provide email ID, first name and last name to **add a user**. If any field is left blank, the screen displays a warning.

**Step Result**: Once you add a user, the user receives an e-mail notification to activate the account.<br>

**Note:** If the user cannot activate and reset the password, the admin may select the **Re-invite User** option to trigger the e-mail notification again.

#### Delete User <a href="#deleteuser" id="deleteuser"></a>

You can delete a user using the delete icon to the right of the user.

![Deleteuser](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/deleteuser.png)

To delete a user, perform the following steps:

1. Navigate to **Users** section.
2. Select the user and click the three dots to the right of the user.
3. Click **Delete**.
4. Click **Yes** on the confirmatory message.

![Confirmdelete](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/confirmdelete.png)

5. You will receive a success message after the user is deleted.

![Deletesuccess](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/userdeletesuccess.png)

#### Clear Cache <a href="#clearcache" id="clearcache"></a>

Delete the user cache using the **clear cache** option to the right of the user. User roles are cached for a short duration on the backend server to facilitate Role-Based Access Control (RBAC). When a user's role changes, delete the user's roles and permissions from the cache using the **Clear Cache** feature. This ensures that the updated roles and permissions take effect immediately.

To clear the cache of a particular user, perform the following steps:

1. Navigate to **Users** section.
2. Select the user and click the three dots to the right of the user.

![clearcache](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/clearcache.png)

3. Click **Clear Cache**.

### Roles <a href="#roles" id="roles"></a>

The **Roles** section displays the multiple roles assigned to the particular user.

![assigntheroles](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/roles.png)

#### Assign the Roles <a href="#assigntheroles" id="assigntheroles"></a>

Following are the steps to assign the roles to the user:

**Using Users Section**

1. Navigate to the **Users** section on the top.
2. Select the respective user and click **Edit**.
3. Select the roles for the user from the drop-down list.

![assigntheroles](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/rolesdropdown.png)

4. Click **Save**.

**Note:** You will receive an e-mail notification for any edits or modifications.

**Using the Roles Section**

1. Navigate to the **Roles** section on the top.
2. Select the role to edit.
3. Under the **List of Users associated with this role**, enter the user's e-mail ID.

![Usingtherolessection](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/listofusers.png)

#### Delete the Roles <a href="#deletetheroles" id="deletetheroles"></a>

You can delete the roles using the **Delete** icon at the right-hand corner of the screen.

![Deletetheroles](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/deleteroles.png)

To delete the roles in the User section, perform the following steps:

1. Navigate to **Users** section.
2. Select the user and click **Edit** on the top right corner of the screen.
3. You must clear the roles of a particular user and click **Save**.

![Deletetheroles](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/deleterolesusingusers.png)

### Usage <a href="#usage" id="usage"></a>

The **Usage** option includes the real-time metrics and the data collected based on the number of days. By default, the data for the last seven days appears. However, you can modify the number of days to view the metrics for a particular category.

To view the usage details, select **Product -> Project -> Category**.

![usagedetails](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/usagedetails.png)

**Note**: The Projects option is available only in Tag Manager. By default, All Projects is selected under **Products** tab.

If there is no data available, then the following message appears: *“Metrics data is currently unavailable.”*

The following are the default user options:

| User Options   | Description                                                                                                                                                                                                     |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tag Manager    | In Tag Manager, SDK enables the client website to trigger API calls to Ingest Labs. In the **Usage** option, the Tag Manager includes metrics that are collected in real-time during the server-side API calls. |
| All Projects   | Select a specific project to collect the metrics using the **All Projects** drop-down.                                                                                                                          |
| All Categories | <p>Includes the following categories to collect the metrics:<br>• Collector API Calls<br>• Server-Side Tag Count<br>• Server-Side Tag API Calls<br>• Collector Bot Traffic</p>                                  |

You can view the following details with the usage in each category:

| Category                  | Description                                                                          |
| ------------------------- | ------------------------------------------------------------------------------------ |
| Collector API Calls       | Denotes the number of Collector API calls from the website to Ingest Labs servers.   |
| Server-Side Tag Count     | Denotes the number of Server-side tags triggered from Ingest Labs servers.           |
| Server-Side Tag API Calls | Denotes the number of Server-side API calls from the website to Ingest Labs servers. |
| Collector Bot Traffic     | Denotes the number of API calls that Ingest Labs servers detect as bot traffic.      |

The same categories are listed under the **All Categories** drop-down for a detailed view of the metrics. For example, to view the Collector API calls from the previous week, click Collector API Calls from the **All Categories** drop-down and select **Last One Week**. To view the graphical representation for the last month, select **Last One Month** and click **Refresh**.

### Notifications <a href="#notifications" id="notifications"></a>

The **Notifications** option displays the notifications triggered for a particular user. You can add any number of e-mail IDs for a Notification Group. The Notifications are triggered at the client level for alarms and other products.

![Notifications](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/notifications.png)

**Note**: While creating alarms, you can set a notification group e-mail for each alarm. The two types of alarms that are triggered under Tag Manager are:\
• Tag Anomaly Detection Alarm\
• Tag Expiration Alarm

To add a new notification group, perform the following steps:

1. Click **Add Notification Group** on the top-right corner of the screen.

![AddNotifications](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/addnotificationgroup.png)

2. In the Info screen, add the Name in the **Name** field.
3. Enter the Description.
4. Enter the e-mail ID in the **Add New User** field under the **Destinations** section.

![Notifications](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/addnewnotificationgroup.png)

5. Click **Save**.

**Step Result**: The new notification is added.

### Integrations <a href="#integrations" id="integrations"></a>

The Integrations section describes the third-party integrations using the Authorization token. You can set the token expiry to 1 hour, 12 hours, and 72 hours accordingly.

![Integrations](https://ingest-lab.netlify.app/images/navigatingthroughuiimages/integrations.png)

[Previo](https://ingest-lab.netlify.app/aboutingestlabs/)

![Integrations](https://docs.ingestlabs.com/images/navigatingthroughuiimages/integrations.png)


# Introduction

The Tag Manager forms the main product in Ingest Labs and comprises the following modules.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

* [Add a New Project](/tag-manager/add-a-new-project)
* [Dashboard](/tag-manager/dashboard)
* [Reports](/tag-manager/reports)
* [Tags](/tag-manager/tags)
* [Data Elements](/tag-manager/data-elements)
* [Providers](/tag-manager/providers)
* [Triggers](/tag-manager/triggers)
* [Qualification Criteria](/tag-manager/qualification-criteria)
* [Transformers](/tag-manager/transformers)
* [Publish](/tag-manager/publish)
* [Live Debugging](/tag-manager/live-debugging)
* [Data Governance](/tag-manager/data-governance)
* [Environments](/tag-manager/environments)
* [Settings](/tag-manager/settings)
* [Alarms](/tag-manager/alarms)


# Add a New Project

## **Introduction**

**Add a New Project** is the first step in the entire Tag Management process soon after you launch the Ingest Labs application.

## Procedure

To add a new Project, perform the following steps:

**Step 1:** On the dashboard, in the **Easily access your products** section, locate **Tag Manager**, and then click **Launch**.

<figure><img src="/files/WR3r3jOiw4UFqskEUeEq" alt=""><figcaption></figcaption></figure>

**Step 2:** On the **Project** screen, in the top-right corner, click **Add Project**.

<figure><img src="/files/ROIiaobPV7RhoWqbttE6" alt=""><figcaption></figcaption></figure>

**Step 3:** On the **New Project** screen, in the **Name** field, enter an appropriate name.

**Step 4:** In the **Description** field, enter a relevant description.

* **Note:** The **Name** and **Description** fields are mandatory. If not provided, an error message **This value is required.** appears below the respective fields.

<figure><img src="/files/ioQy4jjKQg7B6sYoMqBh" alt=""><figcaption></figcaption></figure>

**Step 5:** Under **Project Type**, select an option based on your project:

* Website: Select this option if the project is website-based.
* Mobile App: Select this option if the project is a mobile application.

<figure><img src="/files/GCymLm4AlFGfDKZnya7z" alt=""><figcaption></figcaption></figure>

**Step 6:** If you select **Website**, the **Demand-Side Platform (DSP)** section appears.

**Note:** By default, **Website** is selected.

<figure><img src="/files/SoKGYiVDAPzuIOWar79h" alt=""><figcaption></figcaption></figure>

**Step 6.1:** Check the **Enable DSP integration** checkbox.

DSP Integration: DSP integration is the process of connecting a Demand-Side Platform (DSP) with other systems to deliver targeted ads efficiently by using customer data, campaign insight&#x73;**,** and inventory sources.

<figure><img src="/files/ylGnbvGMoDYKrb52YZ6j" alt=""><figcaption></figcaption></figure>

**Step 6.2:** In the **Select** **Provider** drop-down, select the appropriate provider.

**Note:** DSP integration is enabled only if required by the client.

<figure><img src="/files/ul1bFUnCdmjyKw5GdeMc" alt=""><figcaption></figcaption></figure>

**Step 7:** If you select **Mobile App**, the **Select Mobile App Platform** section appears.&#x20;

<figure><img src="/files/JQMtqcN3k1wUzN9vfLrf" alt=""><figcaption></figcaption></figure>

**Step 7.1**: In the **Select Mobile App Platform** drop-down, select the appropriate platform:

* **Native** – Select this option if the app is developed using native programming languages such as Swift (for iOS) or Kotlin/Java (for Android).
* **React Native** – Select this option if the app is built using React Native, a cross-platform framework that allows you to develop apps for both iOS and Android using JavaScript and React.
* **Ionic** – Select this option if the app is built using Ionic, a framework that enables the development of hybrid mobile applications using web technologies like HTML, CSS, and JavaScript.

<figure><img src="/files/0HuZhSbJ5viYTsAMKzIW" alt=""><figcaption></figcaption></figure>

**Step 8:** Click **Create Project**.

<figure><img src="/files/NmEjdUfuGph7pULmGSNE" alt=""><figcaption></figcaption></figure>

**Result:** This creates the project successfully and adds it to the project list.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fa4aMAw1fprQjHLKQq6Lk%2FAdd%20a%20New%20Project.mp4?alt=media&token=8c4f93e7-53c8-4d79-8565-2584c77c9c15>" %}


# Dashboard

The Dashboard is the visual representation of data as soon as you log in to the Ingest Labs application. The Dashboard showcases a graph of all the information about tags in a singular view. The Dashboard is available for both Staging and Production environments.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Dashboard section includes the following topics:

* [Dashboard Screen](/tag-manager/dashboard/dashboard-screen)
* [Create a New Dashboard](/tag-manager/dashboard/create-a-new-dashboard)
* [Add Widgets in the Dashboard](/tag-manager/dashboard/add-widgets-in-the-dashboard)
* [Configure Default Dashboard](/tag-manager/dashboard/configure-default-dashboard)
* [Edit Dashboard](/tag-manager/dashboard/edit-dashboard)
* [Delete Dashboard](/tag-manager/dashboard/delete-dashboard)
* [Share Dashboard](/media-data-platform/dashboard/share-dashboard)
* [Change Dashboard](/tag-manager/dashboard/change-dashboard)


# Dashboard Screen

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FSueivLpvc7DuPbVoQy2x%2FDashboard%20screen.mp4?alt=media&token=1a4a2c33-0194-4d44-9fbd-7479b2a863a9>" fullWidth="false" %}

**The Dashboard screen includes the following details:**

<figure><img src="/files/lVdrLTL8jNn0bJLo7eVW" alt=""><figcaption></figcaption></figure>

| Dashboard Screen                 | Description                                                                 |
| -------------------------------- | --------------------------------------------------------------------------- |
| Total Tag Fires                  | The total number of tags triggered during a particular duration.            |
| Successful Tag Fires             | The number of tags that the Media Provider successfully receives.           |
| Provider Side Tag Failures       | The tags that failed validation at the Media Provider.                      |
| Tag Validation Failures          | The tags that failed mandatory attributes validation.                       |
| Privacy Blocked Tags             | Tags that are blocked due to privacy consent from the users.                |
| Tag Errors                       | Indicates the unknown tag errors.                                           |
| Success with Validation Failures | The number of tags that are successfully triggered but have missing values. |
| Tag Distribution - Browsers      | The number of successful tags across different browsers.                    |
| Tag Distribution - Devices       | The number of tags across different devices.                                |
| Tag Contribution - Browsers      | The browser composition of tags across the website.                         |
| Tag Contribution - Devices       | The device composition of tags across the website.                          |

By default, the **Dashboard** is set to an hourly session and displays the **Default Dashboard.** To apply the selected time range and update the dashboard data, **click the Refresh button**.

**Custom Time Range**

In the **Custom Range** section, you can select from the following predefined options in the dropdown menu:

* **Today so far** – Displays data from the start of the current day up to the present time.
* **Last 3 hours** – Shows data for the most recent 3-hour window.
* **Last 6 hours** – Displays data collected over the past 6 hours.
* **Last 24 hours** – Provides data for the past 24-hour period.
* **Last 7 days** – Retrieves data from the past 7 days, including the current day.
* **Last 1 month** – Displays data for the previous month from the current date.

<figure><img src="/files/O7CUHoBAyAOOs5s45nBg" alt=""><figcaption></figcaption></figure>

Additionally, you can manually define a start date and end date to filter the dashboard data based on your requirements.

<figure><img src="/files/u68yyAyfZMHp6xvIXVWh" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/hvdCNNzV7Lr3dZNp2aqw" alt=""><figcaption></figcaption></figure>

**Note:** Ingest Labs retains the Dashboard data for a maximum period of 24 months. After 24 months, the data is deleted. To view the Dashboard for a specific custom range, select the time range from the **\~ 24 hours ago** option and click **Refresh**.

Click the **Refresh** button to update the dashboard with the latest data.

<figure><img src="/files/U97KPHFrI8Er9n51ZrZ1" alt=""><figcaption></figcaption></figure>

Click the dropdown to switch the Dashboard display between the **Staging** and **Production** environments.

<figure><img src="/files/egFirUdmVMkasclLhr4i" alt=""><figcaption></figcaption></figure>

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Create a New Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FoeHcCoOY8aOG1VYOwtVv%2FCreate%20a%20new%20dashboard%203.mp4?alt=media&token=1e0b4e1b-ae60-4b5a-8d5d-ec4c208a07ee>" %}

## Introduction

When you select a Project, the default Dashboard opens automatically. However, if you want to create a new Dashboard, follow these steps.

## Procedure

**Step 1**: From the **Default Dashboard** drop-down menu, click **New Dashboard**.

<figure><img src="/files/HYrlUZ5pOJg6DSBqZxEX" alt=""><figcaption></figcaption></figure>

**Step Result:** The New Dashboard screen appears.

![new dashboard](https://ingest-lab.netlify.app/images/dashboardimages/newdashboard.png)

**Step 2:** Enter the Name and Description in the relevant fields.

**Note:** Ensure that the number of characters in the name field is five or more. Else the following message appears:\
\&#xNAN;*Name must be longer than or equal to 5 characters.*

**Step 3***:* Click **Save** to save the changes.

**Step Result:** The new Dashboard is added successfully.

![new dashboard](https://ingest-lab.netlify.app/images/dashboardimages/successmessage.png)

**Note:** You cannot edit the Default Dashboard as the project is configured with the default settings.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Add Widgets in the Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F1BYUc8QsDyq30GlCtis9%2FAdd%20Widget%20to%20the%20new%20Dashboard%206%20(1).mp4?alt=media&token=b4d226ff-533c-4375-803c-a3f284b50227>" %}

## Procedure

Perform the following steps to create widgets in the Dashboard:

## Before you begin

Before adding a widget, ensure that a new dashboard is created. Follow the steps in **Create a New Dashboard** to create a dashboard. Once the dashboard is created, the **New Widget** option becomes available.

**Step 1**: Click **Add Widgets**.

<figure><img src="/files/ikytgdB6Y2JwIKFImqNd" alt=""><figcaption></figcaption></figure>

**Step 2:** The following visualization types are available:

* **Line Chart:** Displays data trends over time by connecting individual data points with a line.
* **Tags Fired Counter:** Counts and displays the number of times specific tags have been triggered.
* **Pie Chart:** Represents data proportions as slices of a circular chart, showing relative sizes.

Select the appropriate chart type.

<figure><img src="/files/JgRaRvftAeT61USJEEiE" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the **Select Aggregation Attribute** section, click the **Select Attribute** dropdown.\
The following options will be displayed:

* Browser
* Device Type
* Language
* Tag Fire Status

<figure><img src="/files/zr5NwtbNPAcjUlTwLYyC" alt=""><figcaption></figcaption></figure>

| Aggregation Attribute | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Browser               | Select this option to display information regarding the Browser types such as **Chrome, Safari, Edge, IE, Firefox, Opera, and Other**.                                                                                                                                                                                                                                                                                                                                                                                                       |
| Device Type           | Select this option to display the device type such as **Desktop Web**, **Mobile Web**, **Tablet**, and **Other**.                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Language              | Select this option to set the preferred language. The available languages are **English**, **Spanish**, and **Other**.                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Tag Fire Status       | <p>Select this option to set to one of the Tag trigger Statuses. </p><p>• Success (200) </p><p>• Success (202) </p><p>• Provider Side Failure (400)</p><p> • Provider Side Failure (404) </p><p>• Provider Side Failure (500) </p><p>• Tag Validation Failure (900) </p><p>• Tag Validation Failure (1000) </p><p>• Error (1001) </p><p>• Privacy Blocked (1002) </p><p>• Skipped (1003) </p><p>• Success with Warnings (1004)</p><p>• Scheduled for retry (1005) </p><p>• Maximum retry attempts reached (1006) </p><p>• Delayed (1007)</p> |

**Step 4:** Click **Add Filter** and select the various criteria to filter information.

**Note:** This step is optional and can be skipped if no filtering is needed.

![add widget](https://ingest-lab.netlify.app/images/dashboardimages/addfilter.png)

| Field Type  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tag         | Specifies the tag that needs to be filtered.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Page Name   | Specifies the Page Name. Select either **contains** or **is** from the Operator drop-down menu.                                                                                                                                                                                                                                                                                                                                                                                       |
| Provider    | Specifies the Provider that needs to be filtered.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Device Type | Select this option to display the device type such as **Desktop Web, Mobile Web, Tablet,** and **Other**.                                                                                                                                                                                                                                                                                                                                                                             |
| Browser     | Select this option to display information regarding the Browser types such as **Chrome, Safari, Edge, IE, Firefox, Opera,** and **Other**.                                                                                                                                                                                                                                                                                                                                            |
| Language    | Select this option to set the preferred language.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Domain      | Select the appropriate domain name. Select either **contains** or **is** from the **Operator** drop-down menu.                                                                                                                                                                                                                                                                                                                                                                        |
| Status      | <p>Select this option to set to one of the Tag trigger Statuses.<br>• Success (200)<br>• Success (202)<br>• Provider Side Failure (400)<br>• Provider Side Failure (404)<br>• Provider Side Failure (500)<br>• Tag Validation Failure (900)<br>• Tag Validation Failure (1000)<br>• Error (1001)<br>• Privacy Blocked (1002)<br>• Skipped (1003)<br>• Success with Warnings (1004)<br>• Scheduled for retry (1005)<br>• Maximum retry attempts reached (1006)<br>• Delayed (1007)</p> |

**Step 5:** Click the **Operator** dropdown.

The following options will be available:&#x20;

* Is one of: Select this operator to filter data where the field matches any of the values in the specified list.
* Is not one of: Select this operator to filter data where the field does not match any of the values in the specified list.

**Step 6:** When you select the **Operator** , a tab opens below. Click the arrow in the tab to select the filter for a specific field type.

![add widget](https://ingest-lab.netlify.app/images/dashboardimages/addfilterselect.png)

**Step 7:** Click **Add Filter** to add the filter conditions.

<figure><img src="/files/OLMTQOfH8MYFbJfylhRp" alt=""><figcaption></figcaption></figure>

**Step 8:** Enter the Widget **Name** and **Description** under the **Widget Info** section and click **Save**.

![add widget](https://ingest-lab.netlify.app/images/dashboardimages/widgetinfo.png)

&#x20; **Step Result:** The new widget is added successfully.

![add widget](https://ingest-lab.netlify.app/images/dashboardimages/successwidget.png)

The Dashboard screen displays the required filtered information for a default period of 24 hours. You can also specify a time range to display the information for a specific period and click **Refresh**.

![add widget](https://ingest-lab.netlify.app/images/dashboardimages/timerange.png)

**Note:** You can perform the same steps as explained in this procedure for the **Tags Fired Counter** and **Pie Chart**.

[<br>](https://ingest-lab.netlify.app/tagmanager/dashboard/createanewdashboard/)

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Configure Default Dashboard

## Introduction

A newly created dashboard can be set as the default dashboard.

## Procedure

Follow these steps to set a newly created dashboard as your default dashboard:

&#x20;**Step 1:** Select **Make Default** from the newly created dashboard drop-down menu.

<figure><img src="/files/I8KYUfN1qwtRSkO206Pw" alt=""><figcaption></figcaption></figure>

A message pops up confirming, *This dashboard has been marked as default.*

<figure><img src="/files/MB9RCjq143sOUybwXt5d" alt=""><figcaption></figcaption></figure>

**Step 2:** To revert the changes, select **Remove as Default**.

<figure><img src="/files/zNErll9nDH2UIVRvK3DY" alt=""><figcaption></figcaption></figure>

**Note:** You must be authorized to perform this action.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Edit Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FiUSdYaCUnEdDuzzHTgEV%2FEdit%20Dashboard%20in%20Tag%20Manager%207.mp4?alt=media&token=54f9a2e6-fd21-451f-a451-2026a91139aa>" %}

## Introduction

The dashboard details of the newly created dashboard can be edited.

## Procedure

To edit the Dashboard details, perform the following steps:

**Step 1**: Select **Edit Dashboard** from the newly created dashboard drop-down menu.

![](https://ingest-lab.netlify.app/images/dashboardimages/editdashboard.png)

**Step 2**:  Edit the details in the **Update Dashboard.**&#x20;

**Step 3:** Click **Save**.

![](https://ingest-lab.netlify.app/images/dashboardimages/updatedashboard.png)

**Step Result:** The dashboard details are updated.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Delete Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F29Kc9VbKLNs9RCefRIUO%2FDelete%20Dashboard%20in%20tag%20manager%201.mp4?alt=media&token=b079b6cc-cc06-47a0-b7b6-316d60735dff>" %}

## Introduction

You can delete the newly created dashboard using this option.

## Procedure

To delete the dashboard, perform the following steps:

**Step 1:** Select **Delete Dashboard** from the newly created dashboard drop-down menu:

![](https://ingest-lab.netlify.app/images/dashboardimages/deletedashboard.png)

**Step 2:** A confirmatory dialog box appears with the message: *Deleting the dashboard will also delete all widgets in it. Would you like to proceed?*

**Step 3:** Click **Yes** to confirm the deletion.

![](https://ingest-lab.netlify.app/images/dashboardimages/deletesuccess.png)

**Step Result:** The Dashboard is deleted successfully along with the added widgets.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Share Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FuZS2IKFNSJR0D5aO9gM5%2FShare%20Dashboard%202.mp4?alt=media&token=a7484f60-c733-43ae-a3fe-92809d9771a2>" %}

## Introduction

A dashboard can be shared with multiple users, and existing users can also be removed from a shared dashboard as needed.

## Procedure

**Perform the following steps to share the Dashboard with other users:**

**Step 1:** Select the **Share Dashboard** option from the newly created dashboard option.

![](https://ingest-lab.netlify.app/images/dashboardimages/sharedashboard.png)

**Step 2:** Enter the e-mail ID in the **Add New User** field and click **Add User**.

<figure><img src="/files/CO6mdCxAFNMpm0FXiLtF" alt=""><figcaption></figcaption></figure>

**Note:** A notification is triggered to the users about the dashboard details.

**Perform the following steps to stop sharing a Dashboard with a user:**

**Step 1:** Select the **Share Dashboard** option from the dashboard screen.

**Step 2:** Click the **Delete** icon against the user's e-mail ID to delete the user from the shared dashboard.

![](https://ingest-lab.netlify.app/images/dashboardimages/deleteuser.png)

**Step Result**: The user details are successfully saved.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Change Dashboard

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FPhVD1YdVktkD5Bx13TNH%2FChange%20Dashboard%207%20(1).mp4?alt=media&token=7ffb4624-08dd-460d-95ce-e407ac9a0b38>" %}

## Introduction

You can change the Dashboard and revert to the Default dashboard.

## Procedure

**Step 1:** From the **Default Dashboard** dropdown menu, select the **Change Dashboard** option.

<figure><img src="/files/ATEFwXvIEgAUukGPPz95" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Project's Default Dashboard** option on the Dashboard screen.

<figure><img src="/files/Ic8FxqWY04mAwtmjsyBQ" alt=""><figcaption></figcaption></figure>

**Step Result:** The default dashboard appears on the screen.

**Step 3:** While viewing the Default Dashboard, you can select and navigate to the specific Dashboard to display.

<table data-view="cards"><thead><tr><th></th><th data-type="rating" data-max="5"></th></tr></thead><tbody><tr><td>Please rate this document to help us improve the content</td><td>null</td></tr></tbody></table>


# Reports

**Reports** displays the details similar to the Dashboard in a list format. You can display reports either for the Staging or Production environment.

While tag details are accessible in the Live Debugging and Dashboard sections, Reports offer critical data for debugging. They provide insights into the tags triggered during a session, including their frequency and associated metrics for data analysis. This information is crucial for diagnosing errors at various levels—whether related to the tag itself, the provider, transformation functions, configuration issues, or missing attributes. Using **Reports**, users can pinpoint specific problems and missing data that may lead to tag failures.

<figure><img src="/files/oDgwarGVIO5iJxLPL7qb" alt=""><figcaption></figcaption></figure>

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Reports section includes the following topics:

* [Reports Screen](/tag-manager/reports/reports-screen)
* [Add Filter](/tag-manager/reports/adding-a-filter-to-reports)


# Reports Screen

## Introduction

The Report screen provides users with a detailed view of data, allowing them to filter and analyze information based on specific time ranges.

<figure><img src="/files/laef7S4jsERARznwO9vc" alt=""><figcaption></figcaption></figure>

## Procedure

**Accessing the Reports**

* Navigate to the left navigation panel.
* Click on **Reports** to open the Report screen.

<figure><img src="/files/Qrs1NfzSTvD3rs3IHScK" alt=""><figcaption></figcaption></figure>

**Understanding Report Columns**

* **Tag Column**: Displays the Tag name.
* **Tag Fires Column**: Shows the number of times the tag is triggered.

<figure><img src="/files/edDyiKEX6HFiPS5alJQK" alt=""><figcaption></figcaption></figure>

**Adding a Filter**

Click **Add Filter.**

<figure><img src="/files/W9rbDoDYb2c2n4e2qQwr" alt=""><figcaption></figcaption></figure>

Select the filter criteria as needed.

<figure><img src="/files/bVFGgxxNFOMVVwFmOHu6" alt=""><figcaption></figcaption></figure>

**Default Time Range**

* Reports are generated for a 24-hour period by default.

**Filtering Reports by Time Range**

* To view reports for a specific time range:

  1. Click the dropdown under **Custom Range**.
  2. Choose one of the available time ranges:
     * Today so far
     * Last 3 hours
     * Last 6 hours
     * Last 24 hours
     * Last 7 days
     * Last month
  3. The report will be displayed based on the selected time range.

  <figure><img src="/files/qp4PP0DK3uqCO8jEEeAp" alt=""><figcaption></figcaption></figure>

**Manually Selecting a Time Range**

* You can manually select a **start date** and **end date** to filter the report data according to your requirements.

<figure><img src="/files/zGgMrqTXVgj4AoAIU0BP" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/PHU5Nco1Jle1ngTiCCMU" alt=""><figcaption></figcaption></figure>

**Note:** You can also manually enter the date and time.

**Refreshing the Report**

* Each time you modify the time range selection, click the **Refresh** button to update the report accordingly.

<figure><img src="/files/Lmp2xAEhcSThKc4hHGWg" alt=""><figcaption></figcaption></figure>

**Selecting the Environment**

* Click the **Environment** dropdown and choose one of the following:
  * **Production**: Redirects to the **Production** environment.
  * **Staging**: Redirects to the **Staging** environment.

<figure><img src="/files/3wLSNpEJpseBCTU7eysg" alt=""><figcaption></figcaption></figure>

**Adjusting Items Displayed per Page**

* Click the dropdown to select the number of items displayed per page.
* The available options are:
  * 20 items per page
  * 50 items per page
  * 100 items per page

<figure><img src="/files/aka5jLGEfX96BbDwuZN1" alt=""><figcaption></figcaption></figure>

**Note:** Ingest Labs retains the metadata information for a period of 6 months at any given point. For customers who have Enterprise contracts with longer data retention needs, Ingest Labs retains and archives the data as agreed in contracts.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FRPoC8mJSwb4Uy2PSnWXL%2FReports%20screen5b7dc553.autosave.mp4?alt=media&token=09f4fb1e-e50b-469e-99cc-f048f2cd7a55>" %}


# Adding a Filter to Reports

## Introduction

This section outlines the steps to add a new filter to the Reports screen.

## Procedure

Follow the steps below to add and apply a filter:

**Step 1:** Access the Filter Option

* Navigate to the **Reports** screen.
* Click **Add Filter**.

<figure><img src="/files/mUN7Aq8btzzeMNTqEvkl" alt=""><figcaption></figcaption></figure>

**Step 2:** Select Field Type

From the **Select a Field** drop-down menu, choose a field type based on your reporting needs.

<figure><img src="/files/Ppmh01oPfviMQ9KP7IsL" alt=""><figcaption></figcaption></figure>

| Field Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Tag**         | Specifies the tag that needs to be filtered.                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **Page Name**   | Specifies the Page Name. Select either **contains** or **is** from the **Operator** drop-down menu.                                                                                                                                                                                                                                                                                                                                                                                |
| **Provider**    | Specifies the Provider that needs to be filtered.                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Device Type** | Select this option to display the device type such as **Desktop Web, Mobile Web, Tablet,** and **Other**.                                                                                                                                                                                                                                                                                                                                                                          |
| **Browser**     | Select this option to display information regarding the Browser types such as **Chrome, Safari, Edge, IE, Firefox, Opera,** and **Other**.                                                                                                                                                                                                                                                                                                                                         |
| **Language**    | Select this option to set the preferred language.                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Domain**      | Select the appropriate domain name. Select either **contains** or **is** from the **Operator** drop-down menu.                                                                                                                                                                                                                                                                                                                                                                     |
| **Status**      | <p>Select this option to set to one of the Tag Fire Statuses.<br>• Success (200)<br>• Success (202)<br>• Provider Side Failure (400)<br>• Provider Side Failure (404)<br>• Provider Side Failure (500)<br>• Tag Validation Failure (900)<br>• Tag Validation Failure (1000)<br>• Error (1001)<br>• Privacy Blocked (1002)<br>• Skipped (1003)<br>• Success with Warnings (1004)<br>• Scheduled for retry (1005)<br>• Maximum retry attempts reached (1006)<br>• Delayed (1007)</p> |

**Step 3:** Choose an Operator

From the **Operator** drop-down menu, select a suitable operator:

* **Is one of** - This operator allows you to filter reports that match any of the selected values.
* **Is not one of** - This operator excludes the selected values from the results.

<figure><img src="/files/0MXum7S41wJxCBdmLGqM" alt=""><figcaption></figcaption></figure>

**Step 4:** Select applicable field types

* Select all the applicable field types from the drop-down.

<figure><img src="/files/TwIMROYzbD7ui6crESTh" alt=""><figcaption></figcaption></figure>

The selected fields are displayed here for confirmation.

<figure><img src="/files/is7XnhuT3b9LHmCQaYib" alt=""><figcaption></figcaption></figure>

**Step 5:** Apply the Filter

Click **Add Filter** to apply the selected criteria.

<figure><img src="/files/hBpO221SqEOckuZ4TSFt" alt=""><figcaption></figcaption></figure>

**Note:** To remove the filter, click the small **cancel** icon next to the filter category.

<figure><img src="/files/T34bR6zDfpYlkDzmYGUK" alt=""><figcaption></figcaption></figure>

**Step Result**

The Reports for the respective field types appear.

**Step 6**: Modify Column Settings

To customize the visible columns:

* Click the **Settings** icon on the top-right corner.
* Select the required columns to display.

<figure><img src="/files/DxUDoFSrbmUnqD3012Tp" alt=""><figcaption></figcaption></figure>

#### **Step 7: Submit Changes**

* Click **Submit** to apply the column settings.

<figure><img src="/files/eSqu98NRSuVBMjYtQSr8" alt=""><figcaption></figcaption></figure>

**Final Result:**  The Reports with the selected columns appear on the screen.

<figure><img src="/files/IG2lSL38KZqM8bUPnxZY" alt=""><figcaption></figcaption></figure>


# Tags

Tags are a collection of data elements, providers, qualification criteria, and privacy settings. Tags are used to build simplified data points and analyze and monitor the data in real-time to ease the marketing processes. You can use the code snippet or MediaPixel to configure the data, send data to providers, and simplify the marketing processes. The two types of Tag Management Solutions are Server-side Tagging solution and Browser/Client-side Tagging solution.

### Server-side Tagging <a href="#server-sidetagging" id="server-sidetagging"></a>

In Server-side Tagging, the events are sent to Ingest Labs and based on the events and configuration of tags, the respective tags are triggered. Server-side tagging includes the marketing needs of the server-side ecosystem. You can collect the data in a first-party consented manner for better control over data collection and transfer the high-performance tag management and streaming to the customer. All integrations are performed using MagicPixel UI platform.

### Client-side Tagging <a href="#client-sidetagging" id="client-sidetagging"></a>

In Client-side tagging, events are not sent to the server and all tasks are performed on the client directly. The tags are triggered on the browser or client website and not sent to the server. Ingest Labs collects the tag information and reports triggered through the SDK on the client website. However, the actual tags are triggered on the client.

<figure><img src="/files/MoZ8STOZkSlECszixRXz" alt=""><figcaption></figcaption></figure>

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Tags section includes the following topics:

* [Tags Screen](https://ingest-lab.netlify.app/tagmanager/tags/tagsscreen/)
* [Configuration of Tags](https://ingest-lab.netlify.app/tagmanager/tags/configurationoftags/)
* [Add a New Tag (Browser)](https://ingest-lab.netlify.app/tagmanager/tags/addanewtagbrowser/)
* [Add a New Tag (Server)](https://ingest-lab.netlify.app/tagmanager/tags/addanewtagserver/)
* [Edit a Tag](https://ingest-lab.netlify.app/tagmanager/tags/editatag/)
* [Disable a Tag](/tag-manager/tags/disable-a-tag)
* [Restore the Changes](/tag-manager/tags/restore-the-changes)
* [Tag Version](/tag-manager/tags/tag-version)

[<br>](https://ingest-lab.netlify.app/tagmanager/reports/addfilter/)


# Tags Screen

## Introduction

This section describes the Tags screen UI elements.

<figure><img src="/files/opmv1tpCnHpud26pJGsR" alt=""><figcaption></figcaption></figure>

## Procedure <a href="#filtertags" id="filtertags"></a>

**Tags (50 of 127)** – This option indicates the number of Tags currently displayed out of the total available Tags.

You can adjust the number of Tags displayed per page using the dropdown menu located at the top-right corner of the screen.

* **50 per page**: Displays up to 50 Tags on the current page.
* **100 per page**: Displays up to 100 Tags on the current page.
* **200 per page**: Displays up to 200 Tags on the current page.

<figure><img src="/files/P3INF4RbX8OjFN9ptjNO" alt=""><figcaption></figcaption></figure>

## Refresh Button

The Refresh button allows you to reload the Tags screen. If you create new Tags or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

## More Options

When you click on the three-dot menu (⋯), the following options are displayed:

* **Clone**: This option allows you to create a duplicate of the selected Tag. When you click Clone, a new Tag is created with the same properties as the original, which you can then modify as needed. It's useful for quickly setting up similar Tags without re-entering all the details.
* **Delete**: This option permanently removes the selected Tag from the system.&#x20;

<figure><img src="/files/RROkYPKkV0M7nfR3uAy1" alt=""><figcaption></figcaption></figure>

## Filter Tags <a href="#filtertags" id="filtertags"></a>

Filter the tags based on the following types:

* **Filter By Name:** Filters tags based on their names.
* **Filter By Attribute Value:** Filters tags based on their attribute values.
* **Filter By Metadata Attribute:** Filters tags based on their metadata attributes.

<figure><img src="/files/i56Q28ribbh3ULocCNaD" alt=""><figcaption></figcaption></figure>

## All Provider Types <a href="#allprovidertypes" id="allprovidertypes"></a>

* **All Provider Types:** Displays a list of all available provider types.
* **Image Tags:** Displays a list of image-based tags.
* **JS Tags:** Displays a list of JavaScript-based tags.

<figure><img src="/files/XQE0e2FZh1Q9QEdXtK5h" alt=""><figcaption></figcaption></figure>

## Tag Status <a href="#filterbyproviders" id="filterbyproviders"></a>

The **Tag Status** defines whether a tag is currently active (Enabled) or inactive (Disabled).&#x20;

**Enabled**

* The tag is active and available for use.
* Select **Enable** from the drop-down menu.
* The list of enabled tags is displayed.

**Disabled:** The tag is **inactive** and hidden from active use. Instead of deleting a tag when it is not needed, you can disable it and re-enable it later if required.

* Select **Disable** from the drop-down men.
* The list of disabled tags is displayed.

<figure><img src="/files/DZP1VQAVplPTRunlmHHs" alt=""><figcaption></figcaption></figure>

## Filter By Providers <a href="#filterbyproviders" id="filterbyproviders"></a>

The **Filter By Providers** option filters the tags based on the providers.

Click **Filter by Providers**.&#x20;

<figure><img src="/files/bYtAqAN9GnJw6jBDZrtL" alt=""><figcaption></figcaption></figure>

The **Choose Providers** panel opens on the right.&#x20;

<figure><img src="/files/lvbEnYnkIEKExMp9YrgK" alt=""><figcaption></figcaption></figure>

Select a provider from the list or use the search bar to find one.

**Note:** You can select one or multiple providers.

Click **Done**.

<figure><img src="/files/HxXNwd8OZtCpPapOJLAA" alt=""><figcaption></figcaption></figure>

**Step Result**: All the tags associated with the Provider Name appear on the screen.

<figure><img src="/files/1ZYW0wJixoBrYE8fkGX7" alt=""><figcaption></figcaption></figure>

## Filter by Qualification Criteria <a href="#filterbyqualificationcriteria" id="filterbyqualificationcriteria"></a>

The **Filter by Qualification Criteria** option allows you to filter tags based on a predefined qualification criteria list.

Click on **Filter by Qualification Criteria**.

<figure><img src="/files/do0mNYTyLM0udzEjtS1N" alt=""><figcaption></figcaption></figure>

The **Choose Qualification Criteria** dialog box appears on the right side of the screen.

Select the applicable qualification criteria from the list.

Alternatively, enter the name of the criteria in the **Filter by Name** field to search for a specific criterion.

<figure><img src="/files/lxylXgSuz6a1bCpKCtOe" alt=""><figcaption></figcaption></figure>

Click **Done** to apply the filter.

<figure><img src="/files/fNzGWtz93hm0hmb5DA20" alt=""><figcaption></figcaption></figure>

**Step Result:** Click a tag. Under **Qualification Criteria**, the selected qualification criteria is displayed.

<figure><img src="/files/DX0V8irGNTENfPomFaC9" alt=""><figcaption></figcaption></figure>

## Filter by Triggers <a href="#filterbydataelements" id="filterbydataelements"></a>

This option allows you to filter tags based on specific trigger conditions.

Click on **Filter by Triggers**.

<figure><img src="/files/xNflyvbzjTNfEfQbJXgH" alt=""><figcaption></figcaption></figure>

The **Choose Triggers** panel opens on the right side of the screen.

<figure><img src="/files/rUfYXbkOxwdY9J1cGUis" alt=""><figcaption></figcaption></figure>

Select one or multiple triggers from the list, or use the search bar to find specific triggers.

<figure><img src="/files/tIvN25FNefFoCq1S0A1r" alt=""><figcaption></figcaption></figure>

Click **Done** to apply the filter.

<figure><img src="/files/0J6kQm5v91qGj72aqrdl" alt=""><figcaption></figcaption></figure>

To view the selected trigger(s), click on the tag. the associated triggers will be displayed under the **Triggers** section.

<figure><img src="/files/A5B3kMLQxYUQMGQC0h7F" alt=""><figcaption></figcaption></figure>

## Filter by Data Elements <a href="#filterbydataelements" id="filterbydataelements"></a>

The **Filter by Data Elements** option allows you to filter tags based on predefined Data Elements.

Click on **Filter by Data Elements**.

<figure><img src="/files/oBB85MWRnUOXAcpCTAZa" alt=""><figcaption></figcaption></figure>

The **Choose Data Elements** dialog box appears.

Select one of the following options:

* **Default Data Elements**
* **User-Defined Data Elements**

Enter the name of the Data Element in the 'Filter by Name' field to search for a specific element. You can either type the name or select it from the list.

Click **Done** to apply the filter.

<figure><img src="/files/grgGb8FEFf6KMxSjKhFS" alt=""><figcaption></figcaption></figure>

**Step Result**: All the tags associated with the Data Elements appear on the screen.

## Reset Filters <a href="#resetfilters" id="resetfilters"></a>

The **Reset Filters** option resets the applied filter settings.

<figure><img src="/files/p2Cza7rt3yFFRpSV49B0" alt=""><figcaption></figcaption></figure>

## **The following are the additional fields that appear on the Tags screen**

| Column Name         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**            | Denotes the Tag Name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **Support**         | Denotes whether the tag is a server-side or a browser-side setting.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **Status**          | <p>Denotes the tag status:<br>• Production<strong>:</strong> Displays the tags in the production stage.<br>• Staging: Displays the tags in the Staging process.<br>• Pending Publish: Displays the tags yet to be published.<br>• Published: Displays the published tags.<br>• Deleted: Displays the deleted tags.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| **Provider**        | <p>Denotes the Provider name and the format.<br>• IMG: Denotes the Provider in the Image format.<br>• JS: Denotes the Provider in the Java Script format.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **Validity Period** | Denotes the validity period of the tag configured while creating the tag.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **Updated By**      | Specifies the user who updated the tag.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ...                 | <p>The Ellipsis on the last column denotes whether to delete the tag or clone the tag.<br>To delete a tag there must not be any dependencies.<br>Note<strong>:</strong> You cannot delete a tag if there are any dependencies in the tag for Data Elements, Providers, Triggers, or Qualification Criteria. Only after deleting the dependent categories, you can delete the tag successfully.<br>Even after deleting the dependencies, if you cannot delete the tag, then you must Publish the relevant categories first and then perform the delete operation.<br>The Clone option allows you to clone the tags based on the selection of the already available providers. You can view the same settings for a particular provider and edit the required details and additional information for the new tag.</p> |

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fj1fmXvDAaXnRt47ZDuFx%2FTag%20screen.mp4?alt=media&token=73184cc8-ec87-4164-a012-969d09c439fb>" %}


# Configuration of Tags

You can add a tag using any of the following options:

* **Browser**: For the conventional method of tagging using the browser.
* **Server**: For backward compatibility and support to create new tags on the server.

In Ingest Labs, you can create media tags for client-side and server-side seamlessly and quickly using the following steps. For browser-side tagging creation, the conventional method of tagging is applicable.

The following elements are mandatory to add a new tag:

| Tag Elements                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Providers](/tag-manager/providers)                           | <p>The Provider acts as a template to define the attributes on a high-level, before configuring the tag. You can select any of the available provider templates, set the attributes, save the provider template, and configure the tag.<br><strong>Note</strong>: If the default provider templates are unavailable, you can create a custom-defined template using the Providers option on the left navigation panel.</p> |
| [Data Elements](/tag-manager/data-elements)                   | The Data elements refer to the data points that are sent to the Provider to populate the values while configuring the tag.                                                                                                                                                                                                                                                                                                 |
| [Triggers](/tag-manager/triggers)                             | The Triggers indicate when a particular tag is to be triggered based on the data inputs. The triggers are associated with different actions and events while performing the tasks under tags.                                                                                                                                                                                                                              |
| [Qualification Criteria](/tag-manager/qualification-criteria) | The Qualification criteria refer to the rules and conditions required to trigger a tag for a particular scenario. You must set the rules when the tags are to be triggered for different scenarios and send the data to the data endpoints.                                                                                                                                                                                |


# Add a New Tag (Browser)

## Introduction

You can add a new tag to capture browser or client-side data. This helps in tracking specific user interactions or behaviors based on browser activity.

## Procedure

To add a new Tag for browser/client-side, perform the following steps:

**Step 1:** Select **Tags** from the left navigation panel.

<figure><img src="/files/A93fTj1f9EA4HPGiOmOZ" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Add Tag** dropdown in the top right, then select **For Browser** from the list.

<figure><img src="/files/6EQom6M6xJm0NXMR440n" alt=""><figcaption></figcaption></figure>

**Step 3:** The **Select Provider** panel opens on the right side. You can choose a provider from the list or use the search bar to find and select a provider.

<figure><img src="/files/oW6Xgl2GxIL5C0FhdtRq" alt=""><figcaption></figcaption></figure>

After selecting a provider, the **Tags** screen opens.

<figure><img src="/files/FZyMkmQKWoB9cdDIWWaV" alt=""><figcaption></figcaption></figure>

**Step 4:** Select Trigger

**Step 4.1:** In **Triggers**, click **Choose Trigger**.

<figure><img src="/files/0DrYn0tXn8CSX9UGDImF" alt=""><figcaption></figcaption></figure>

**Step 4.2:** The **Choose Triggers** panel opens with two tabs:

* **User-Defined**: Displays custom triggers created by users.
* **Default**: Contains predefined system triggers.

**Step 4.3:** Select a trigger from the list or use the search bar to find and select a trigger.

**Note:** Multiple triggers can be selected.

**Step 4.4:** Click **Done**.

<figure><img src="/files/pUJGjfvGij7DXHZ89Mhw" alt=""><figcaption></figcaption></figure>

The selected trigger appears on the **Triggers** screen.

**Note 1:** You can remove the selected trigger by clicking the **Clear** button or click the small cancel icon next to each trigger to remove them individually.

<figure><img src="/files/qoGT07j6nwPvT5PgE6Ck" alt=""><figcaption></figcaption></figure>

**Note 2:** If mandatory details are not filled in, the following warning message gets triggered:

![](https://ingest-lab.netlify.app/images/tagsimages/triggerwarning.png)

![](https://ingest-lab.netlify.app/images/tagsimages/mandatoryfieldwarning.png)

**Step 5:** Qualification Criteria (Optional)

The Qualification Criteria are the conditions/triggers that inform Ingest Labs when to trigger a particular tag. You can add multiple Qualification Criteria, and these criteria are layered.

**Step 5.1:** Click **Qualification Criteria (Optional)**.

<figure><img src="/files/xBKTG32JpHoGNehbemwn" alt=""><figcaption></figcaption></figure>

**Step 5.2:** The **Qualification Criteria** panel opens on the right side.

Select a qualification criterion from the list or use the search bar to find and select one.

You can select multiple qualification criteria.

**Step 5.3:** Click **Done**.

<figure><img src="/files/b741ivICnPWQblK1u39E" alt=""><figcaption></figcaption></figure>

The selected qualification criteria appear on the **Qualification Criteria (Optional)** screen.

**Note:** You can click **Clear** to remove all selected qualification criteria at once, or click the small cancel icon next to each one to remove them individually.

<figure><img src="/files/vzfrEwyRHuuFOYMFknB2" alt=""><figcaption></figcaption></figure>

**Step 6:** Tag Info

You can set the tag name and validity period. The default validity period is one year for any new tag and can be set to any desired date. To understand tag validity or expiry, see the section **Set the Validity period and Tag Expiry**.

**Step 6.1: Name:** The Tag name.

**Step 6.2: Validity Period:** Denotes the Tag Validity period including Start Date and End Date.

![](https://ingest-lab.netlify.app/images/tagsimages/taginfo.png)

**Set Validity and Tag Expiry**

While creating a tag in Tag Manager, you can set the validity period of a particular tag and define its expiry. The default validity period is one year for any new tag and can be set to any desired date. When the expiry date is close, you will receive a reminder e-mail notification about the tag expiry. If no action is taken, the tag stops triggering post the set validity period.

See ExpirationAlarm for more information.

**Step 7:** Set Provider Attributes

The Provider is a mandatory setting while adding a new tag. You can add any number of Provider attributes using the Key-Value pair and configure the settings using the Settings option. For a particular Provider attribute, you must set the value either from the Data Elements or Transformers. The user can view the provider attributes added from Provider side configuration.

![](https://ingest-lab.netlify.app/images/tagsimages/setproviderattributes.png)

**Step 7.1:** If you do not set the mandatory values, the following message appears:

![](https://ingest-lab.netlify.app/images/tagsimages/attributewarning.png)

**Step 7.2:** After selecting either from the Data Element or Transformer, the value appears in the **Value** column.

![](https://ingest-lab.netlify.app/images/tagsimages/providerattributesvalues.png)

**Step 8:** Set Tag Attributes

To add Attributes, select **Add Attributes** and set the following values.

![](https://ingest-lab.netlify.app/images/tagsimages/addattributes.png)

**Step 8.1: Name**: Set the Attribute name. For example: visitor\_id, user\_id, and so on.

**Step 8.2: Value**: Set the value either for the Data Element or Transformer.

**JSON**: Enter the Attribute name and value, and configure the Settings.

* Mandatory - Denotes the value to be mandatory.
* Ignore If Empty - Ignore the field if empty.
* Hash (SHA256) - denotes the value in the HASH format.

![addanewtagbrowser](https://ingest-lab.netlify.app/images/tagsimages/addattributesjson.png)

**Static**: Denotes the static Value that is known.

**Step 8.3: Attribute Settings**

Enter the **Attribute Settings**.

**Step 8.4: Tool-tip!** Select the **Mandatory** check box to display the **Fatal** check box.

![](https://ingest-lab.netlify.app/images/tagsimages/attributesettings.png)

**Step 8.5:** Set the Data Type Conversion using the following options.

| Data Type Conversion     | Description                                                                               |
| ------------------------ | ----------------------------------------------------------------------------------------- |
| No Conversion            | Indicates that there is no conversion required for the data type.                         |
| Convert to Boolean       | Converts the input data to Boolean.                                                       |
| Convert to Number        | Converts the input data to Number.                                                        |
| Convert to Array         | Converts the input data to Array.                                                         |
| Convert to Object Spread | Converts the JSON attributes under a parent level attribute to the root level attributes. |

**Step 8.6:** Select one of the following Transformer types and click **Confirm**.

| Transformer Type | Description                                     |
| ---------------- | ----------------------------------------------- |
| URL encode       | Converts the URL in the encrypted format.       |
| HASH (SHA256)    | The value is converted to HASH (SHA256) format. |
| Ignore if empty  | May be ignored if the value is empty.           |

**Step 8.7:** Select the **Ignore Redaction** checkbox to display the data elements. Redaction is a setting for each data element, which allows the server-side processing to apply the redaction strategy - like anonymize for email.

**Step Result:** The Provider Attribute is created.

To delete the Provider Attribute, select the **Delete** icon at the right-hand corner of the screen.

**Step 9:** Denote the **Script**.

The Script denotes the code script if available for the tag. Select the **No Script** check box if the script is unavailable.

![addanewtagbrowser](https://ingest-lab.netlify.app/images/tagsimages/script.png)

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fvc4qKJhjUX7u6Qu41ALT%2FAdd%20a%20New%20Tag%20(Browser).mp4?alt=media&token=062b6e54-0e38-43ea-881b-5acf5de633f1>" %}


# Add a New Tag (Server)

## Introduction

Server-side tagging lets you shift tag execution from your website or app to a secure server environment. Instead of loading multiple tags in the browser, data is sent to a server where tags are triggered. This improves site speed, enhances data accuracy, and gives you more control over what data is shared with third parties.

## Procedure

To add a new server-side tag, perform the following steps:

**Step 1**: Select **Tags** from the left navigation panel.

<figure><img src="/files/FdWC1rzQ34gRAYVUSOgM" alt=""><figcaption></figcaption></figure>

**Step 2**: Click the **Add Tag** dropdown select **For server**.

<figure><img src="/files/UaQW1TpoVO6R97OJBtNM" alt=""><figcaption></figcaption></figure>

**Step 3:** The **Select Provider** panel opens on the right side. Select a provider from the list or use the search bar to find and select a provider.

<figure><img src="/files/bszEtZQzl5dESd1krxqK" alt=""><figcaption></figcaption></figure>

**Step Result:** The **New tag** screen appears.

<figure><img src="/files/blVHCvSMl0VPtT4bgn7a" alt=""><figcaption></figcaption></figure>

**Step: 4:** **Trigger**.

**Step 4.1:** Click **Choose Triggers.**

<figure><img src="/files/enmH66CURy6gCRWAkxtn" alt=""><figcaption></figcaption></figure>

**Step 4.2:** The **Choose Triggers** panel opens on the right side. Choose a trigger from the list or use the search bar to find and select a trigger, then click **Done**.

**Note:** You can select multiple triggers if needed.

<figure><img src="/files/GCkejzrdhC78WIjRCfaz" alt=""><figcaption></figcaption></figure>

**Step Result:** The tag is triggered for the respective trigger data.

<figure><img src="/files/kyeRg3EDiLFVce0ARGDW" alt=""><figcaption></figcaption></figure>

**Step 5:** Set Qualification Criteria (Optional).

**Step 5.1:** Click Qualification Criteria (Optional).

Qualification Criteria of a tag are conditions/triggers that inform Ingest Labs when to trigger a particular tag. You can add multiple Qualification Criteria and these criteria are layered.

***Note 1:** This step is optional.*

<figure><img src="/files/hD0PlvFGRDcXBnvrubIS" alt=""><figcaption></figcaption></figure>

**Step 5.2:** The **Choose Qualification Criteria** panel opens on the right side. Select an option from the dropdown or use the search bar to find and select a criterion, then click **Done**.

***Note 2:*** You can select multiple qualification criteria if needed.

<figure><img src="/files/fYRaDPmwQXvSFgdAOCOf" alt=""><figcaption></figcaption></figure>

**Step 6:** Set Tag Info

This is the step where you set a name and validity period for the tag. The default validity period is one year for any new tag that is created and can be set to any desired date.&#x20;

**Step 6.1: Name:** The Tag name.

**Step 6.2: Validity Period:** Denotes the validity period of the tag including Start Date and End Date.

***Note** : If you don't enter the tag name, an error message appears: **This value is required**.*

![](https://ingest-lab.netlify.app/images/tagsimages/taginfovalidityperiod.png)

Set Validity and Tag Expiry

While creating a tag on Ingest Labs, you can set the validity period of a particular tag and define tag expiry. The default validity period is one year for any new tag that is created and can be set to any desired date. When the expiry date is closer, you will receive reminder e-mail notification about the expiry of the tag. If no action is taken, the tag stops triggering post the set validity period. You can find all expired tags in the “Paused State” in the Publish section and you can remove the expired tags to reduce the size of your SDK.

Set Tag Query Parameters

The Query parameters include the set of dynamic values that are included along with the Base URL while executing the query. These parameters appear in the Attributes section as well along with the values.

![](https://ingest-lab.netlify.app/images/tagsimages/tagqueryparam.png)

**Step 7:** Set Provider Attributes

The Provider is a mandatory setting while adding a new tag. You can add any number of Provider attributes using the Key-Value pair and configure the settings using the Settings option. The user can view the providers attributes added from Provider side configuration.

For a particular Provider attribute, you must set the value either from the Data Elements or Transformers.

![](https://ingest-lab.netlify.app/images/tagsimages/setproviderattributes.png)

After selecting either from the Data Element or Transformer, the value appears in the **Value** column.

![](https://ingest-lab.netlify.app/images/tagsimages/providerattributesvalueserver.png)

**Step 7.1:** Add Attributes

To add Attributes, select **Add Attributes** and set the following values.

![](https://ingest-lab.netlify.app/images/tagsimages/addattributesserver.png)

**Step 7.1.1: Name**: Set the Attribute name. For example: visitor\_id, user\_id, and so on.

**Step 7.1.2: Value**: Set the value either for the Data Element or Transformer.

**Step 7.1.3: JSON**: Enter the Attribute name and value, and configure the Settings.

* Mandatory - Denotes the value to be mandatory.
* Ignore If Empty - Ignore the field if empty.
* Hash (SHA256) - denotes the value in the HASH format.

![](https://ingest-lab.netlify.app/images/tagsimages/addattributesserverjson.png)

**Step 7.1.4: Static**: Denotes the static Value that is known.

**Step 7.1.5:** Attribute Settings:

Enter the **Attribute Settings**.

**Tool-tip!** Select the **Mandatory** check box to display the **Fatal** check box.

![](https://ingest-lab.netlify.app/images/tagsimages/attributesettings.png)

**Step 7.1.6:** Set the Data Type Conversion using the following options.

| Data Type Conversion     | Description                                                                               |
| ------------------------ | ----------------------------------------------------------------------------------------- |
| No Conversion            | Indicates that there is no conversion required for the data type.                         |
| Convert to Boolean       | Converts the input data to Boolean.                                                       |
| Convert to Number        | Converts the input data to Number.                                                        |
| Convert to Array         | Converts the input data to Array.                                                         |
| Convert to Object Spread | Converts the JSON attributes under a parent level attribute to the root level attributes. |

**Step 7.1.7:** Select one the following Transformer types and click **Confirm**.

| Transformer Type | Description                                     |
| ---------------- | ----------------------------------------------- |
| URL encode       | Converts the URL into the encrypted format.     |
| HASH (SHA256)    | The value is converted to HASH (SHA256) format. |
| Ignore if empty  | May be ignored if the value is empty.           |

**Step 7.1.8:**  Select the **Ignore Redaction** checkbox to display the data elements. Redaction is a setting for each data element, which allows the server-side processing to apply the redaction strategy - like anonymize for email.

**Step Result:** The Provider Attribute is created.

**Step 7.1.9:**  To delete the Provider Attribute, select the **Delete** icon at the right-hand corner of the screen.

**Step 7.1.10:**  Click **Save** to save the settings.

**Step Result:** The new tag is created.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FpRhDUJan2nEiMESEzKtA%2FAdd%20a%20New%20Tag%20(Server).mp4?alt=media&token=f25242a1-22c5-4f12-9394-0358602e5789>" %}


# Edit a Tag

## Introduction

You can edit the Tag details of a particular tag.

## Procedure

To edit the tag, perform the following steps:

**Step 1:** Select the tag that you want to edit.

<figure><img src="/files/gESRogPNIefzZosbkWWD" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/WpodHKdFmSqm5c1yvdo6" alt=""><figcaption></figcaption></figure>

**Step 3:** Edit the tag details and click **Save** on the top-right to save the changes.

<figure><img src="/files/USymYmTfFJD3uFfMgeES" alt=""><figcaption></figcaption></figure>

## Edit Metadata <a href="#editmetadata" id="editmetadata"></a>

**Step 1:** Click **Metadata** and click **edit**

![](https://ingest-lab.netlify.app/images/tagsimages/editmetadata.png)

**Step 2:** Add the Key and the value.

**Step 3:** Click **Add** to add more keys and values.

![](https://ingest-lab.netlify.app/images/tagsimages/editmetadata.png)

**Step 4:** Click **Save** to save the Metadata.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FDHfSokNeyORbWi9Lc1Xi%2FEditing%20a%20tag.mp4?alt=media&token=35ac0c34-2c73-4745-ad37-ce39c28fa856>" %}


# Disable a Tag

## Introduction

You can disable the details of a particular tag.

## Procedure

To disable a tag, perform the following steps:

**Step 1:** Select the tag that you want to disable.

<figure><img src="/files/jhpH5B55RwsqL5koio0c" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Disable**.

<figure><img src="/files/ubO6mbVvKgjvPsfU71Hv" alt=""><figcaption></figcaption></figure>

**Step Result**: The tag is disabled successfully.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fn0cW46fJn4yfYbWT83La%2FDisabling%20a%20tag.mp4?alt=media&token=488affc2-b7a0-4a80-9e9b-f1d0759dfc7a>" %}


# Enable a Tag

## Introduction

You can enable tag details for a specific tag.

## Procedure

To enable a enable tag, perform the following steps:

**Step 1:** Select the tag that you want to enable from the list of tags.

**Note:**  A disabled tag can be identified by its faded or lighter color. When you hover over it, a tooltip appears indicating that the tag is disabled.

<figure><img src="/files/sfDkr5BHvya2LuvOxINq" alt=""><figcaption></figcaption></figure>

**Step 2:** Go to **Tag Status**, click the **dropdown**, and select **Disabled** from the list.

<figure><img src="/files/RWHV2q7ViIukXvDF7scC" alt=""><figcaption></figcaption></figure>

It will display a list of disabled tags. Select the tag you want to enable.

<figure><img src="/files/skIOGjPy3NGxTaJJcDF8" alt=""><figcaption></figcaption></figure>

**Step 3:** From the **Actions** drop-down menu on the top right corner, select **Enable**.

<figure><img src="/files/ERnKC7W885SAuCrLuSnC" alt=""><figcaption></figcaption></figure>

**Step Result**: The tag is enabled successfully.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FVO986YwHRujYc6xYy9iT%2FEnable%20a%20tag.mp4?alt=media&token=9db80707-6cc9-4dbe-a38d-b0b2dd64249c>" %}


# Restore the Changes

## Introduction

A deleted tag can be restored with all its settings using the **Restore** option.

## Procedure

To restore a deleted tag, perform the following steps:

**Step 1:** Select a deleted tag.

<figure><img src="/files/1fXVmjchvTy6k8POFMWR" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Actions** button drop-down and select **Restore**.

<figure><img src="/files/3gOY1rwaiOCSEHpkl8H6" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** in the Restore confirmatory dialog box that appears.

![](https://ingest-lab.netlify.app/images/tagsimages/restoretag.png)

**Step Result**: The tag is restored successfully.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FRFc36f9CA1yOuvAXVADz%2FRestore%20the%20option.mp4?alt=media&token=a1bf850e-c96a-4205-961c-948aa4db8c18>" %}


# Tag Version

Every tag includes a version number on the top-right corner of the screen. Once the tag is published, the version is set to 1. That is Version 1. After subsequent edits and only after publishing the version number keeps updating to the latest version such as version 2, version 3, and so on.

<figure><img src="/files/8c8iPDdjZaTW4MEoEOKZ" alt=""><figcaption></figcaption></figure>

**Note**: Until the Tag is published, the status displays as **Pending Publish**. If the Tag is published in staging, the status is updated as **Staging**. If the Tag is published in production, the status is updated as **Production**.

## Restoring a Tag Version

To restore a specific tag version, follow the steps below:

1. Navigate to the version you want to restore.
2. Click the **Action** dropdown button.
3. Select **Restore to this version** from the menu.

<figure><img src="/files/AhdXqcL9H9PWCDwfrR75" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FksE9IDYXEilEvVF3UCu3%2FTag%20versions.mp4?alt=media&token=3c1a74e7-2e4e-4c82-bf04-d57b5e8901e6>" %}


# Data Elements

Data Elements are the core components you define while creating the tags. Data elements act as components that intelligently fetch information from across your digital property. You can create any number of custom Data elements for a particular Data type and define the elements in the tags as per client requirements. Some of the Data types include Server Header, Server Cookie, Magic Pixel Data Layer, URL Parameter, Custom JavaScript, Custom event, and so on.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Data Elements section includes the following topics:

* [Data Elements Screen](/tag-manager/data-elements/data-elements-screen)
* [Add a New Data Element (Browser)](/tag-manager/data-elements/add-a-new-data-element-browser)
* [Add a New Data Element (Server)](/tag-manager/data-elements/add-a-new-data-element-server)
* [Edit a Data Element](/tag-manager/data-elements/edit-a-data-element)
* [Delete a Data Element](/tag-manager/data-elements/delete-a-data-element)
* [Restore the Changes](/tag-manager/tags/restore-the-changes)
* [Data Element Version](/tag-manager/data-elements/data-element-version)

[<br>](https://ingest-lab.netlify.app/tagmanager/tags/tagversion/)


# Data Elements Screen

## Introduction

This section describes the Data Elements UI screen options.

<figure><img src="/files/IeW8OvyVnoswrZSzAwX0" alt=""><figcaption></figcaption></figure>

### Add Data Element <a href="#filterdataelements" id="filterdataelements"></a>

To create a new Data Element, click on the **Add Data Element** option located at the top-right corner of the screen.

<figure><img src="/files/G3eF8J7PbrVz9IOnnap7" alt=""><figcaption></figcaption></figure>

### Adjust Data Elements View Per Page

**Data Elements (6 of 6)**\
This section shows the number of Data Elements currently displayed out of the total available.

You can adjust how many Data Elements are shown per page using the dropdown menu at the top-right corner of the screen:

* **50 per page** – Displays up to 50 Data Elements on the current page.
* **100 per page** – Displays up to 100 Data Elements on the current page.
* **200 per page** – Displays up to 200 Data Elements on the current page.

<figure><img src="/files/7tHfko5eHKlEXCkFo6UG" alt=""><figcaption></figcaption></figure>

### Filter Data Elements <a href="#filterdataelements" id="filterdataelements"></a>

You can filter the Data Elements based on the following types:

* **Filter by Name:**\
  Use this filter to narrow down Data Elements based on their names.
* **Filter by Attribute Value:**\
  Use this filter to narrow down Data Elements based on their attribute values.
* **Filter by Metadata Attribute:**\
  Use this filter to narrow down Data Elements based on their metadata attributes.

<figure><img src="/files/VeuyV5fJN2vZjjv2TYHJ" alt=""><figcaption></figcaption></figure>

### Additional Fields on the Data Elements Screen

The following are the additional fields that appear on the **Data Elements** screen.

<figure><img src="/files/HFA3mZevJrnIJ58E0EEv" alt=""><figcaption></figcaption></figure>

| Column Name | Description                                                                                                                                                                                                                                                                                                                                  |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name        | Denotes the Data Element Name.                                                                                                                                                                                                                                                                                                               |
| Support     | <p>Denotes whether the tag is a server-side or a browser-side setting.<br>• C: Denotes that the Data Element is client-side.<br>• S: Denotes that the Data Element is server-side.</p>                                                                                                                                                       |
| Status      | <p>Denotes the status of the Data Element:<br>• Production: The Data Element is in the production stage.<br>• Staging: The Data Element is in the Staging process.<br>• Pending Publish: The Data Element is yet to be Published.<br>• Published: The Data Element is in the Published stage.<br>• Deleted: The Data Element is deleted.</p> |
| Type        | Denotes the type of the Data Element. For example, URL Parameter, Custom Java script, and so on.                                                                                                                                                                                                                                             |
| Created By  | Denotes the user who created the Data Element.                                                                                                                                                                                                                                                                                               |
| Updated By  | Denotes the user who updated the Data Element.                                                                                                                                                                                                                                                                                               |
| Updated On  | Denotes when the Data Element is last updated.                                                                                                                                                                                                                                                                                               |

### Refresh the Data Elements Screen

The **Refresh** button allows you to reload the DATA elements screen. If you create new DATA elements or update their properties and the changes are not immediately visible on the main UI screen, clicking the **Refresh** button will reload the page to display the most up-to-date information.

<figure><img src="/files/3vJE1i8wVVV4icHreMZh" alt=""><figcaption></figcaption></figure>

**Default DATA Elements Checkbox**

Select the **Default Data Elements** check box at the top to list the readily available default data elements. The specific default template will be used for the particular data elements.

Clearing the checkbox shows all available DATA elements.

<figure><img src="/files/XBxhyEKfeTMTN68nQmsl" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FuBiJbdfZkMuu2oDg2Omm%2Fdata%20element%20screen.mp4?alt=media&token=989d02ef-4dd7-4e7d-9cf6-e62ed7b4b35f>" %}


# Add a New Data Element (Browser)

## Introduction

For Client-side or Browser-side configuration, all the information is fetched from the webpage or browser.&#x20;

## Procedure

Perform the following steps to create a Data element for the browser:

**Step 1:** Click the ***Add Data Element*** dropdown and select ***Browser***.

<figure><img src="/files/0aozKsVjonBVp86KANib" alt=""><figcaption></figcaption></figure>

**Step 2:** Under the **Info** section, enter the following details in the respective fields:

<figure><img src="/files/AEikmAVflULkBJ9EDtEs" alt=""><figcaption></figcaption></figure>

| Field Name                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name                                  | Denotes the default Data Element Name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Variable Name                         | <p>Denotes the variable name.<br>Note<strong>:</strong> The Variable name is the same as the Data Element name.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Description                           | Enter the description of the Data Element.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Is a Language Data Element?           | The language that must be essentially used in the particular website. There can be only one Language Data Element for a particular Data Element.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Is a Privacy Compliance Data Element? | Denotes if the user or customer has provided consent for data collection. There can be only one Privacy Compliance Data Element for a particular Data Element.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Choose Data Element Type              | <p>Denotes the data element type.<br>• URL Parameter: Denotes the parameters that are fetched from the URL.<br>• Launch Data Element: This is a reference to the Adobe Launch data element if the client's website has Adobe launch configured and the Adobe launch SDK downloaded on their website.<br>• Custom JavaScript: Includes the Custom Java Script code that the user provides as input. The code must be included in the Custom Java Script section while adding the Data Elements.<br>• Ingest Labs Data Layer: Includes the Data Layer that the Ingest Labs generates. You can specify the path in the Element Name that is a JSON object and provide values.</p> |

**Step 3:** Under *Data Element Type*, there is a dropdown labeled ***Choose Data Element Type*****.** The available options are:

* URL Parameter
* Launch Data Element
* Custom JavaScript
* Ingest Labs Data Layer

<figure><img src="/files/UnERtnt3Lk5zZ6juOg7c" alt=""><figcaption></figcaption></figure>

**Step 3.1:** URL Paramete&#x72;**:**

<figure><img src="/files/mnUQ0IX8qI0Ms1MdznTm" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/VvYaIkit8klrtNRtGrPK" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/zPfYsQWZtOdiZ4sVvHd2" alt=""><figcaption></figcaption></figure>

| Field Name     | Description                                                                                                                                                                                                                                                                                                                                                    |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Parameter Name | This is a mandatory field. Enter the parameter name.                                                                                                                                                                                                                                                                                                           |
| Default value  | <p>Represents the Default Value of the parameter.<br>• Empty String: Denotes that the data element is a string value.<br>• Undefined<strong>:</strong> If the data element is not supposed to be used then select Undefined.<br>• Null: Denotes the Null data type for the data element.<br>• Custom Value: Denotes the static value for the Data Element.</p> |
| Case-sensitive | Select the Case-sensitive check box to make the default parameter case-sensitive. Else, clear the check box.                                                                                                                                                                                                                                                   |

**Step 3.1.1:** Transformation Function

Enter the following fields in the Transformation Function section.

<figure><img src="/files/zsiZqM6rKTQwgRaUy2uC" alt=""><figcaption></figcaption></figure>

| Field Name        | Description                                                                                                                                                                                    |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Default Functions | <p>• Clean: Clears and trims any white spaces on the trailing and leading strings after collecting the data value.<br>• Lowercase: Denotes that the string needs to be in the lower-case.</p>  |
| Custom Function   | Use Custom Function: For performing other transformations, you can write the code, retrieve or convert the value into a new value, and return the new value in the code using Custom function. |

**Step 3.1.2:** Redaction

Select the Redaction option for the data element if it contains sensitive information.\
When redaction is enabled and a strategy is applied, the backend server will scramble or mask the data when it is used in a tag or provider to maintain privacy.

Data Classification:

Under the Redaction section, click the **Data Classification** dropdown and choose the appropriate classification type based on the data element. The available options are:

* Not Applicable – No redaction strategy is applied.
* Email – Digits in the email are scrambled.
* IP Address – The last octets of the IP address are zeroed out.
* Phone Number – The first 3 digits are retained; the remaining digits are set to 0.
* Date – The month and year are kept; the date is set to 1.

<figure><img src="/files/pToOFkaLwXLDlJSr73rI" alt=""><figcaption></figcaption></figure>

**Step 3.1.3:** Storage Duration

In the Storage Duration field, select how long the data element should be retained. The available options are:

* EVENT – The data is stored only for the duration of the event.
* NONE – The data is not stored.
* SESSION – The data is stored for the duration of the user session.
* VISITOR – The data is stored across multiple sessions for the same visitor.

<figure><img src="/files/MIzT5q7BwmKFP0A0ekzn" alt=""><figcaption></figcaption></figure>

**Step 3.2:** Launch Data Element

Enter the following fields in the Launch Data section of the screen.

<figure><img src="/files/E8TorDoe7DEVHlwav5JS" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/9Nw6YN0cxoLZi1ANo2dm" alt=""><figcaption></figcaption></figure>

| Field Name    | Description                                                                                                                                                                                                                                                                                                                                      |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Element Name  | This is a mandatory field. Enter the data element name.                                                                                                                                                                                                                                                                                          |
| Default value | <p>Represents the Default Value of the data element.<br>• Empty String: Denotes that the data element is a string value.<br>• Undefined: If the data element is not supposed to be used then select Undefined.<br>• Null: Denotes the Null data type for the data element.<br>• Custom Value: Denotes the static value for the Data Element.</p> |

**Step 3.2.1:** Redaction

Select the Redaction option for the data element if it contains sensitive information.\
When redaction is enabled and a strategy is applied, the backend server will scramble or mask the data when it is used in a tag or provider to maintain privacy.

Data Classification:

Under the Redaction section, click the **Data Classification** dropdown and choose the appropriate classification type based on the data element. The available options are:

* Not Applicable – No redaction strategy is applied.
* Email – Digits in the email are scrambled.
* IP Address – The last octets of the IP address are zeroed out.
* Phone Number – The first 3 digits are retained; the remaining digits are set to 0.
* Date – The month and year are kept; the date is set to 1.

<figure><img src="/files/BoEk6xRoWGAHea0Y43LU" alt=""><figcaption></figcaption></figure>

**Step 3.3:** Custom JavaScript

In this field, you can enter a custom JavaScript function to define advanced logic or processing for the data element. Ensure the code is valid and tested before saving.

**Step 3.3.1:** Is Async Function? (Checkbox):\
Check this box if the custom JavaScript function is asynchronous. Enabling this allows the system to correctly handle promises returned by the function.

<figure><img src="/files/a6Scn3QIQGN8M9uTaT6O" alt=""><figcaption></figcaption></figure>

**Step 3.4:** Ingest Labs Data Layer

Under the **Ingest Labs Data Layer** section, configure the following fields:

**Step 3.4.1:** Element Name:

Enter the name of the data element.&#x20;

<figure><img src="/files/JVmxBpxcKj18vG3XlPt8" alt=""><figcaption></figcaption></figure>

**Step 3.4.2:** Default Value:&#x20;

Specify a default value for the element, used when no value is received from the data layer.\
The same storage options apply here as in the previous section:

* EVENT – Data is stored only for the duration of the event.
* NONE – Data is not stored.
* SESSION – Data is retained for the user session.
* VISITOR – Data is retained across multiple sessions for the same visitor.

<figure><img src="/files/1grlJw0lDPWr5ZpBvomv" alt=""><figcaption></figcaption></figure>

**Note:** Transformation Function, Redaction, and Storage Duration fields follow the same steps as described above.

**Step 3.5:** Click **Save** to save the changes.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fk3F321CnxEeV6QmqPseV%2FData%20element%20browser.mp4?alt=media&token=a227d105-084e-4e87-b509-e0d035a8b9f8>" %}


# Add a New Data Element (Server)

## Introduction

This document provides step-by-step guidance on adding a new data element for server-side configuration.

## Procedure

Perform the following steps to create the Data elements on browser:

**Step 1:** Click the ***Add Data Element*** dropdown and select  ***For Server***.

<figure><img src="/files/g7HrANd9LwamQFC18Na8" alt=""><figcaption></figcaption></figure>

**Step 2:** Under the **Info** section, enter the following details in the respective fields:

<figure><img src="/files/7Imvr8c1ldyCAFRXB5et" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Agpr0Pupc2bFCGRlKHWi" alt=""><figcaption></figcaption></figure>

| Field Name               | Description                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                     | The Default Data Element Name.                                                                                                                                                                                                                                                                                                                                      |
| Variable Name            | <p>Denotes the variable name.<br><strong>Note</strong>: The Variable name is same as the Data Element name.</p>                                                                                                                                                                                                                                                     |
| Description              | Enter the description of the Data Element.                                                                                                                                                                                                                                                                                                                          |
| Choose Data Element Type | <p>Select the appropriate data element type based on your requirements:</p><ul><li><strong>Server Cookie:</strong> Retrieves data from server-side cookies.</li><li><strong>Server Header:</strong> Fetches data from HTTP headers sent by the server.</li><li><strong>JSON Path:</strong> Extracts data from JSON responses using a specified JSON path.</li></ul> |

**Step 3:** Click *Server Cookie*.

**Step 3.1:** Cookie Name: Enter the name of the cookie. This field is mandatory.

<figure><img src="/files/tDh260WOfRu0JFd4Jjvm" alt=""><figcaption></figcaption></figure>

**Step 3.2:** Default Value:

Select the **Default** Value from the drop-down. If the value for a particular data element is unavailable, the default value is used.

* Undefine&#x64;**:** If the data element is not supposed to be used then select Undefined.
* Empty Strin&#x67;**:** Denotes that the data element is a string value.
* Nul&#x6C;**:** Denotes the Null data type for the data element.
* Custom Valu&#x65;**:** Denotes the static value for the Data Element.

<figure><img src="/files/iIuntbHG6dllI0vm865a" alt=""><figcaption></figcaption></figure>

**Step 3.3:** Data Classification

Choose Data Classification:&#x20;

Select the appropriate classification for the data the element represents:

* Not Applicable
* Email
* Phone Number
* IP Address
* Date

<figure><img src="/files/B5eh7fwCTfOxbLXlhc7I" alt=""><figcaption></figcaption></figure>

**Step 3.3.1:** Redaction Strategy:

When you select Emai&#x6C;**,** Phone Numbe&#x72;**,** IP Address, or Date, an additional option appears:

Choose how the sensitive data should be handled:

* Not Applicable
* Anonymiz&#x65;**:** Masks or transforms the data to anonymize it.

<figure><img src="/files/GwuINxnYLqwa96GMRxX4" alt=""><figcaption></figcaption></figure>

**Step 4:** Click *Server Header*.

**Step 4.1:** Header Name: Enter the name of the server header. This field is *mandator&#x79;**.***

<figure><img src="/files/KT3CAtz4ravkInm1pQkJ" alt=""><figcaption></figcaption></figure>

**Step 4.2:** Default Value: Choose a fallback value if the actual data is unavailable:

* Undefine&#x64;**:** If the data element is not supposed to be used then select Undefined.
* Empty Strin&#x67;**:** Denotes that the data element is a string value.
* Nul&#x6C;**:** Denotes the Null data type for the data element.
* Custom Valu&#x65;**:** Denotes the static value for the Data Element.

<figure><img src="/files/BigGlfI3H1XgVWJcyeUv" alt=""><figcaption></figcaption></figure>

**Step 4.3:** Redaction

Data Classification

Choose Data Classification:&#x20;

Select the appropriate classification for the data the element represents:

* Not Applicable
* Email
* Phone Number
* IP Address
* Date

<figure><img src="/files/vO5V41jcWiysaIBs4Ey6" alt=""><figcaption></figcaption></figure>

**Step 4.3.1:** Redaction Strategy

When you select Email, Phone Number, IP Address, or Date, an additional option appears:

Choose how the sensitive data should be handled:

* Not Applicable
* Anonymiz&#x65;**:** Masks or transforms the data to anonymize it.

<figure><img src="/files/PJhzmFWgJSjStESmkvYu" alt=""><figcaption></figcaption></figure>

**Step 5:** Click Json path

**Step 5.1:** Enter the name of the JSON path data element. This field is mandatory.

<figure><img src="/files/cC7XYleF2kDv5j1Rc56J" alt=""><figcaption></figcaption></figure>

**Step 5.2:** Default Value:

* Undefine&#x64;**:** The data element will not be used.
* Empty Strin&#x67;**:** Sets the value as an empty string.
* Null: Assigns a `null` value to the data element.
* Custom Valu&#x65;**:** Enter a static value to use by default.

<figure><img src="/files/ItvoMx67DE6UI1x407Al" alt=""><figcaption></figcaption></figure>

**Step 5.3:** Clean\
Clean: Clears and trims any white spaces on the trailing and leading strings after collecting the data value.

**Step 5.4:** Lowercase:\
Denotes that the string needs to be in lower-case.

<figure><img src="/files/nBawdjvnhmaitxJwincr" alt=""><figcaption></figcaption></figure>

**Step 5.5:** Redaction

Choose Data Classification:&#x20;

Select the appropriate classification for the data the element represents:

* Not Applicable
* Email
* Phone Number
* IP Address
* Date

<figure><img src="/files/kgrArhK7CquS2PdI8hSa" alt=""><figcaption></figcaption></figure>

**Step 5.5.1:** Redaction Strategy:

When you select Emai&#x6C;**,** Phone Number, IP Address, or Date, an additional dropdown appears:

* Not Applicabl&#x65;**:** No redaction is applied.
* Anonymiz&#x65;**:** Personally identifiable information is masked or transformed.

<figure><img src="/files/wzzOgpsl5qZ9rVIne5Is" alt=""><figcaption></figcaption></figure>

**Step 6:** Once all the required fields are filled in, click Save

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FcH16OCXzQCbxoKZlJhpA%2FAdd%20a%20New%20Data%20Element%20(Server).mp4?alt=media&token=442bb24d-f122-4a74-a8d5-05250a8526d6>" %}


# Edit a Data Element

## Introduction

This document explains the step-by-step procedure to edit a Data Element.

## Procedure

To edit the Data Element, perform the following steps:

**Step 1:** Select the Data Element you want to edit.

<figure><img src="/files/EgsLSy0KmIgZubCfRZ8L" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/zgypsIKh6NmDjNmGCKT6" alt=""><figcaption></figcaption></figure>

**Step 3:** Edit the Data Element details and click **Save** on the top-right to save the changes.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FwA24DftXI5fyKGZUjZKX%2FEdit%20a%20Data%20Element.mp4?alt=media&token=8c8f642a-aca5-4541-bc77-b5400da12017>" %}


# Delete a Data Element

## Introduction

This document outlines the step-by-step procedure for deleting a particular Data Element.

## Procedure

To delete a Data Element in Ingest Labs, perform the following steps:

**Step 1:** Select the Data Element you want to delete.

<figure><img src="/files/NVZVoibYLQEpCERZRDp9" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Delete**.

<figure><img src="/files/oaguZv5U7XUNMN3VFXhq" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** on the confirmatory message that appears.

![](https://ingest-lab.netlify.app/images/dataelementsimages/deleteconfirmatory.png)

**Step result**: The Data Element is deleted successfully.

**Note 1:** You cannot delete a Data Element if there are any dependencies in the tag. Only after deleting the dependent categories, you can delete the Data Element successfully.

![](https://ingest-lab.netlify.app/images/dataelementsimages/deletedependencies.png)

**Note 2:** Even after deleting the dependencies, if you cannot delete the Data Element, then you must Publish the relevant categories first and then perform the delete operation.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FVktzCjT05OPjn6nZFwGB%2FDelete%20data%20element.mp4?alt=media&token=d497bb74-307c-46cb-ab81-4a54c155ed61>" %}


# Restore the Changes

## Introduction

This document provides step-by-step instructions on how to restore a deleted Data Element using the Restore option.

## Procedure

To restore a deleted data element, perform the following steps:

**Step 1:** Navigate to the Data Elements screen to view the deleted Data Element.

<figure><img src="/files/JYNeqyS2AgoC6aHSUAXW" alt=""><figcaption></figcaption></figure>

**Step 2:** Select the ***Data Element*** you want to delete.

**Step 3:** In the top right corner, click the ***Action*** dropdown, then select ***Restore***.

<figure><img src="/files/CnLv7Sab5mgDJFnHfwi1" alt=""><figcaption></figcaption></figure>

**Step 3:** A restore confirmation dialog box appears. Click **Yes** to proceed.

![](https://ingest-lab.netlify.app/images/dataelementsimages/restoreconfirmatory.png)

**Step Result**: The Data Element is restored successfully.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FA0eK7jihYm1tgONQziDF%2FRestore%20data%20element.mp4?alt=media&token=dc97b462-88c1-41dc-84fd-9a7d49d8eeea>" %}


# Data Element Version

## Overview

Every Data Element includes a version number on the top right corner of the screen. Once the Data Element is published, the Version is set to 1. That is Version 1.

## Version Number Location

After subsequent edits and only after publishing, the version number keeps on updating to the latest version such as Version 2, version 3, and so on.

<figure><img src="/files/SDh5MFKrUyKgLyOkq0Js" alt=""><figcaption></figcaption></figure>

## Versioning Logic

* When a **new Data Element** is created and **published for the first time**, it is assigned **Version 1**.
* Every time the Data Element is **edited and then published again**, the version number is incremented:
  * Example: Version 2, Version 3, and so on.

**Note 1**: For the default Data Elements, the version is always set to “1” because these are populated from the template.

**Note 2**: Until the Data Element is published, the status displays **Pending Publish**. When the data element change is published in staging or production environment, the status is updated with the corresponding environment in the Data Elements screen.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FcPM4jQ8G87M20uHBVfQE%2FData%20Element%20Versioning.mp4?alt=media&token=8362e7b3-8632-420b-8b25-355e2957d078>" %}


# Providers

The Providers are the key components to be defined before you create tags. Providers include Media providers for implementing the server-side and client-side tags. You can select from the provider templates created and listed by Ingest Labs or add a custom provider template.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Providers section includes the following topics:

* [Providers Screen](/tag-manager/providers/providers-screen)
* [Add a New Provider (Browser)](/tag-manager/providers/add-a-new-provider-browser)
* [Add a New Provider (Server)](/tag-manager/providers/add-a-new-provider-server)
* [Edit a Provider](/tag-manager/providers/edit-a-provider)
* [Delete a Provider](/tag-manager/providers/delete-a-provider)
* [Provider Version](/tag-manager/providers/provider-version)


# Providers Screen

## Introduction

This section describes the Providers screen UI elements.

<figure><img src="/files/blP52p4mss36ZZmxFf3G" alt=""><figcaption></figcaption></figure>

### Add Provider

To create a new Provider, click on the **Add Provider** option located at the top-right corner of the screen.

<figure><img src="/files/7E1sSSheREtx9oJdXugg" alt=""><figcaption></figcaption></figure>

### Filter Providers <a href="#filterproviders" id="filterproviders"></a>

You can filter the Providers based on the following types:

* **Filter By Name**: Filters the providers based on the Provider name.
* **Filter By Attribute Value**: Filters the Providers based on Attribute Value.
* **Filter By Metadata Attribute**: Filters the Providers based on Metadata Attribute.

<figure><img src="/files/orZxUaXuNGeTtKqZcJkZ" alt=""><figcaption></figcaption></figure>

### Adjust Providers View Per Page

You can adjust the number of providers displayed per page using the dropdown menu located at the top-right corner of the screen.

* **50 per page**: Displays up to 50 providers on the current page.
* **100 per page**: Displays up to 100 providers on the current page.
* **200 per page**: Displays up to 200 providers on the current page.

<figure><img src="/files/xunFp8QHOiw68IpumCLB" alt=""><figcaption></figcaption></figure>

### Additional Fields on the Providers Screen

The following are the additional fields that appear on the Providers screen.

<figure><img src="/files/F6zT6APDCXbhGTnK41ap" alt=""><figcaption></figcaption></figure>

| Column Name | Description                                                                                                                                                                                                   |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name        | Denotes the Provider Name.                                                                                                                                                                                    |
| Support     | Denotes whether the Provider is a server-side or a browser-side setting.                                                                                                                                      |
| Status      | <p>Denotes the status of the Provider.<br>• Production: The Provider is in Production status.<br>• Staging: The Provider is in Staging status.<br>• Pending Publish: The Provider is yet to be Published.</p> |
| Type        | Denotes the type of the Provider. For example, IMG, JS, and so on.                                                                                                                                            |
| Created By  | Denotes the user who created the Provider.                                                                                                                                                                    |
| Updated By  | Denotes the user who updated the Provider.                                                                                                                                                                    |
| Updated On  | Denotes when the Provider is last updated.                                                                                                                                                                    |
| Add Tag     | You can create the tag using this option from the Providers.                                                                                                                                                  |

### All Provider Types <a href="#allprovidertypes" id="allprovidertypes"></a>

The **All-Provider Types** drop-down menu displays the following provider types:

* All Provider Types
* Image Tags: Providers that use image-based tracking.
* JS Tags: Providers that use JavaScript for tracking.

![](https://ingest-lab.netlify.app/images/providersimages/allprovidertypes.png)

### Filter By **Data Elements** <a href="#filterbydataelements" id="filterbydataelements"></a>

The **Filter By Data Elements** option filters the Data Elements based on the Data Element selected.

<figure><img src="/files/JVmr4HZGgaEvvwGZ8kXi" alt=""><figcaption></figcaption></figure>

The *Choose Data Elements* panel opens.

You can either:

* Use the **Search bar** at the top to find specific Data Elements, or
* Browse through the two available tabs:
  * **User Defined**: Custom Data Elements created by users.
  * **Default**: Predefined Data Elements available in the system.

<figure><img src="/files/7y1sq4XFfqIoWiYKaj0O" alt=""><figcaption></figcaption></figure>

Note: You can choose a combination of both *User Defined* and *Default* Data Elements.

<figure><img src="/files/eyHIgPGtkIumvkJtrMIB" alt=""><figcaption></figcaption></figure>

Deselect: To remove a selected Data Element, click the small **x** icon next to it.

<figure><img src="/files/soNFE15IcC1cNFp77wFe" alt=""><figcaption></figcaption></figure>

Refresh: Click the Refresh button to load the most recent Data Elements.&#x20;

A **Fetching Data Elements...** message appears while the system retrieves and displays the updated data.

<figure><img src="/files/ktAZEBHBv9TkQHgYynaA" alt=""><figcaption></figcaption></figure>

Once you’ve finished selecting, click the **Done** button to apply your choices.

<figure><img src="/files/KODJdR6e6PpzsUxSHBL3" alt=""><figcaption></figcaption></figure>

### Reset Filters <a href="#resetfilters" id="resetfilters"></a>

The **Reset Filters** option resets the applied filters.

<figure><img src="/files/7AGZvHKoojCoWyE6C5g2" alt=""><figcaption></figcaption></figure>

### Refresh the Provider Screen

**Refresh Button**\
The Refresh button allows you to reload the Providers screen. If you create new providers or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

<figure><img src="/files/zZ6f6groKoDahNNSpgkZ" alt=""><figcaption></figcaption></figure>

### Add Tag

Click the **Add Tag** button to add a new tag.

<figure><img src="/files/trtMO1FGkllKWVXWIaTH" alt=""><figcaption></figcaption></figure>

Note: For detailed steps on adding tags, please refer to the **Tags** section of this document.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FVXrikKNnkYhmgNdOi1km%2FProviders%20Screen.mp4?alt=media&token=abd4a71d-de67-4ddb-ba51-47cfe8621cbb>" %}


# Add a New Provider (Browser)

### Introduction

This document explains step by step how to add a provider to the browser side. All the information required for Client-side or Browser-side configuration is fetched from the webpage or browser.

### Procedure

To add a new Provider in Tag Manager, perform the following steps:

**Step 1:** From the left navigation panel, select **Providers**.

<figure><img src="/files/b7zSaeIRRuy9d7kIQXyf" alt=""><figcaption></figcaption></figure>

**Step 2:** Select **Add Provider -> For Browser** on the top-right corner of the screen.

<figure><img src="/files/AAIv2ogAWMe2BWDnrt1a" alt=""><figcaption></figcaption></figure>

**Step 3:** The **Provider Template** panel opens on the right side and choose a template from the list or use the **Search** bar to find a specific one.

<figure><img src="/files/ftuk7stQzWkl3kjUYw1M" alt=""><figcaption></figcaption></figure>

Note: In the list, each template includes a label such as *IMG*, *JS*, or *APP*, indicating whether the provider uses an image-based, JavaScript-based, or app-based implementation.

<figure><img src="/files/JEivdgQYLZ6nDALy4eeo" alt=""><figcaption></figcaption></figure>

**Step 4:** Let us take an example of the **Facebook JS** provider template.

<figure><img src="/files/Zg3jKRPHYvFL7yCJ2LQc" alt=""><figcaption></figcaption></figure>

**Step 5:** Under **Provider Details**, the **Name** and **Description** fields will already be filled in.

<figure><img src="/files/gczM8DCgeFd7aiyd92yb" alt=""><figcaption></figcaption></figure>

**Step 6:** The Script section includes both the Template script and Provider script.

![](https://ingest-lab.netlify.app/images/providersimages/script.png)

You can enter the JavaScript in the Provider Script section and click **Save** to save the changes.

**Step 7:** The **Attributes** section lists the Attributes for Data Elements and Transformers. This is an Optional section.

![](https://ingest-lab.netlify.app/images/providersimages/attributes.png)

**Step 7.1:** Click **Choose Data Element.**

<figure><img src="/files/vQVNRmr78XrMR8fQ5lUy" alt=""><figcaption></figcaption></figure>

**Step 7.1.1:** The **Select Data Element** panel opens on the right side of the screen.

At the top of this panel, you’ll find a **Search Bar**.

You can either:

* Use the search bar to find a specific Data Element, or
* Choose from the list displayed under the two tabs:
  * User-Defined
  * Default

<figure><img src="/files/Y6e1t6uf3QxyS5NYsNKa" alt=""><figcaption></figcaption></figure>

**Step Result:** The selected Data Element is visible in the Value section.

<figure><img src="/files/KEkaJuDXvuZoH2NpcrMT" alt=""><figcaption></figcaption></figure>

**Note:** To cancel the selected Data Element, click the small **x icon** next to the selected item.

<figure><img src="/files/emuxaBEDJdJJ1q6QnVUd" alt=""><figcaption></figcaption></figure>

**Step 7.1.2:** Attribute Settings

Under the Settings section, you can configure the following options for each attribute:

* Mandatory: Select this checkbox to make the value mandatory.
* Fatal: Select this checkbox to stop the process if the value is missing or invalid.
* Ignore If Empty: Select this checkbox to skip this value during processing if it is not set.
* Hash (SHA256): Select this checkbox to securely convert the value into a SHA256 hash before processing.

<figure><img src="/files/ZGENpxhDm0LFJlHUx84J" alt=""><figcaption></figcaption></figure>

**Step 7.1.3:** Settings

Click the **Settings** option, the *Attribute Settings* window opens.

<figure><img src="/files/gURL5nCUnlAvyIJi3i76" alt=""><figcaption></figcaption></figure>

**Note:** All the attributes selected earlier will already be checked. If you want to make changes, you can update them here.

<figure><img src="/files/edP6kqvz8RWEZ9KhDWWR" alt=""><figcaption></figcaption></figure>

Under **Transformers**, you will find the **URL Encode** checkbox.\
Check this box if you want the value to be automatically encoded for safe transmission in a URL.

<figure><img src="/files/GSLoCGs6yXd65TukglE7" alt=""><figcaption></figcaption></figure>

**Step 7.1.4:**&#x44;ata Type Conversion

Click the **Data Type Conversion** drop-down.

The following options are available:

* No Conversion: Indicates that there is no conversion required for the data type.
* Convert to Boolean: Converts the input data to Boolean.
* Convert to Number: Converts the input data to a number.
* Convert to Array: Converts the input data to Array.
* Convert to Object Spread: Converts the JSON attributes under a parent level attribute to the root level attributes.

<figure><img src="/files/lEN6ZfFORR3qfN2QXg2E" alt=""><figcaption></figcaption></figure>

**Step 7.2:** Click **Choose Transformer.**

<figure><img src="/files/ccJBeukW3PDaohxBbaKs" alt=""><figcaption></figcaption></figure>

**Step 7.2.1:** The **Select Transformer** panel opens on the **right side** of the screen.

At the top of the panel, there is a **Search Bar**.\
You can either:

* Use the search bar to quickly find a Transformer, or
* Browse through the list displayed below and select a Transformer manually.

<figure><img src="/files/7HkK6iLI1kdWAIr7gKyJ" alt=""><figcaption></figcaption></figure>

**Step Result:** The selected Transformer is visible in the Value section.

<figure><img src="/files/NKdKNADRc2zVRQQzjSub" alt=""><figcaption></figcaption></figure>

**Note:** To cancel the selected Transformer, click the small **x icon** next to the selected item.

**Step 7.2.2:** Attribute Settings

Under the Settings section, you can configure the following options for each attribute:

* Mandatory: Select this checkbox to make the value mandatory.
* Fatal: Select this checkbox to stop the process if the value is missing or invalid.
* Ignore If Empty: Select this checkbox to skip this value during processing if it is not set.
* Hash (SHA256): Select this checkbox to securely convert the value into a SHA256 hash before processing.

<figure><img src="/files/SBvdgE5Gtfq828j1PKtV" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/gV6MyRtulpfVIpKzcLWz" alt=""><figcaption></figcaption></figure>

**Step 7.2.3:** Settings

Click the **Settings** option, the *Attribute Settings* window opens.

<figure><img src="/files/qZPXKait6WKOfwAkzJ0m" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/veDN5Vt6MAWJV4VbHdUw" alt=""><figcaption></figcaption></figure>

**Note:** All the attributes selected earlier will already be checked. If you want to make changes, you can update them here.

Under **Transformers**, you will find the **URL Encode** checkbox.\
Check this box if you want the value to be automatically encoded for safe transmission in a URL.

<figure><img src="/files/zeeMtxjKql7DJz3i6Iqt" alt=""><figcaption></figcaption></figure>

**Step 7.2.4:** Data Type Conversion

Click the **Data Type Conversion** drop-down.

The following options are available:

* No Conversion: Indicates that there is no conversion required for the data type.
* Convert to Boolean: Converts the input data to Boolean.
* Convert to Number: Converts the input data to a number.
* Convert to Array: Converts the input data to Array.
* Convert to Object Spread: Converts the JSON attributes under a parent level attribute to the root level attributes.

<figure><img src="/files/K7v8KPl6GZQdoiTwfDAg" alt=""><figcaption></figcaption></figure>

**Step 8:** Click **Save** on the top right to save the new Provider (Browser).

![](https://ingest-lab.netlify.app/images/providersimages/cancelandsave.png)

**Note**: The page displays the following success message.

![](https://ingest-lab.netlify.app/images/providersimages/successmessage_provider.png)

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FTUD76VdpKjI5ofS5NGOV%2FAdd%20a%20New%20Provider%20(Browser).mp4?alt=media&token=4aebdd7f-2347-4af8-9dd8-32530966bb02>" %}


# Add a New Provider (Server)

## Introduction

This document provides a step-by-step guide to adding a provider to the server-side configuration. All the required information is collected directly from the server.&#x20;

## Procedure

To add a new Provider on Ingest Labs, perform the following steps:

**Step 1:** Click **Add Provider** and select **Server** from the options available at the top-right corner of the screen.

<figure><img src="/files/QzJRkvmZDPTGpQfhL1Yc" alt=""><figcaption></figcaption></figure>

**Step 2:** The **Provider Template** panel appears on the right side of the screen.\
Select a template from the available list, or use the **Search** bar to quickly find a specific template.

![c](https://ingest-lab.netlify.app/images/providersimages/customimageprovider.png)

**Step 3:** Let's take an example of the **Facebook Conversion API** provider template.

<figure><img src="/files/X70LLjXoacO0DaqhN3rT" alt=""><figcaption></figcaption></figure>

Note: In the list, each template includes a label such as *IMG*, *JS*, or *APP*, indicating whether the provider uses an image-based, JavaScript-based, or app-based implementation.

**Step 4:** The **Provider Details** section is automatically pre-filled based on the selected provider.\
However, you can make changes if needed by editing the available fields.

<figure><img src="/files/d6rwCFYgdYOap86ObSZM" alt=""><figcaption></figcaption></figure>

**Step 5:** In the **Attributes** section, you can view the attributes for **Data Elements** and **Transformers**.

**Step 5.1:** Click **Choose Data Element** to select the relevant data element for the attribute.

<figure><img src="/files/SXL9ldz9jJ64agjP8WCP" alt=""><figcaption></figcaption></figure>

**Step 5.1.1:** The **Select Data Element** panel opens on the right side of the screen.\
At the top of this panel, you will see a **Search** bar.

You can do one of the following:

* Use the **Search** bar to find a specific data element, or
* Browse and select from the list displayed under the two tabs:
  * **User-Defined**
  * **Default**

<figure><img src="/files/jJpDtk20Lq4MAov99XOf" alt=""><figcaption></figcaption></figure>

**Step Result:** The selected Data Element is visible in the Value section.<br>

**Note:** To cancel the selected Data Element, click the small **x icon** next to the selected item.

<figure><img src="/files/SeiNAo38sJjysstZtH3g" alt=""><figcaption></figcaption></figure>

**Step 5.1.2:** Settings Configuration:

Under the **Settings** section, the following checkboxes are available:

* Mandator&#x79;**:** Ensures the attribute must be set.&#x20;
* Fata&#x6C;**:** Terminates the process if the value is missing or invalid.
* Ignore If Empt&#x79;**:** Skips the attribute during processing if no value is provided.
* Hash (SHA256)**:** Converts the value into a secure SHA256 hash.

<figure><img src="/files/DXRvmkVqLHUZigQZJS7l" alt=""><figcaption></figcaption></figure>

**Step 5.1.3:** Click **Settings** to configure these options.

<figure><img src="/files/kTUX2kicr6usfTBBCy2I" alt=""><figcaption></figcaption></figure>

**Step 5.1.4:** The **Attribute Settings** window opens.

<figure><img src="/files/Y9SBcBoAB4pEND2uFrMj" alt=""><figcaption></figcaption></figure>

**Note**:&#x20;

* All previously selected attributes will appear ticked.
* You can uncheck any previously selected items or check the boxes for new attributes as needed.

<figure><img src="/files/c97ZBEsxL3CNjb2qgNtZ" alt=""><figcaption></figcaption></figure>

**Step 5.1.5:** Under the **Transformers** section:

* URL Encode: Check this box if you want the value to be automatically encoded for safe URL transmission.

<figure><img src="/files/Xsx6Um5E46Hjbtd4nLzL" alt=""><figcaption></figcaption></figure>

**Step 5.1.6:** Click the **Data Type Conversion** drop-down.\
\
The following options are available:

* No Conversion: No change will be applied to the data.
* Convert to Boolean: Changes the data to `true` or `false`.
* Convert to Number: Converts the input into a numeric value.
* Convert to Array: Transforms the data into an array format.
* Convert to Object Spread: Moves JSON attributes from a nested level to the root level.

<figure><img src="/files/AQXTM2qVKYTsH1ZL9YQV" alt=""><figcaption></figcaption></figure>

**Step 5.1.7:** Redaction Options

In the **Redaction** section, two checkboxes are available:

* Ignore Redaction: Skips applying redaction rules for this attribute.
* Exclude from Request Body: Prevents this attribute from being included in the outgoing request payload.

<figure><img src="/files/Be8h7OJvlj7CS6bEWYl1" alt=""><figcaption></figcaption></figure>

**Step 5.1.8:** Once all the required fields are filled:

* Click **Confirm** to save the configuration.
* **Note**: To discard changes, click **Cancel**.

<figure><img src="/files/AFfUx789uD8Mp2wnwweS" alt=""><figcaption></figcaption></figure>

**Step 5.2:** Click Choose Transforme&#x72;**.**

<figure><img src="/files/CTBL8Uxq1UIgK8ibHWB1" alt=""><figcaption></figcaption></figure>

**Step 5.2.1:** The **Select Transformer** panel opens on the **right side** of the screen.

At the top of the panel, there is a **Search Bar**.\
You can either:

* Use the search bar to quickly find a Transformer, or
* Browse through the list displayed below and select a Transformer manually.

<figure><img src="/files/9mRfxn6UP0U7f5w98iO4" alt=""><figcaption></figcaption></figure>

**Step Result:** The selected Transformer is visible in the Value section.

<figure><img src="/files/1Fycipuhx5TljG3otCOE" alt=""><figcaption></figcaption></figure>

**Note:** To cancel the selected Transformer, click the small **x icon** next to the selected item.

<figure><img src="/files/NGhPZr7dL8WwyqjG49xK" alt=""><figcaption></figcaption></figure>

**Step 5.2.2:** Settings Configuration:

Under the **Settings** section, the following checkboxes are available:

* Mandator&#x79;**:** Ensures the attribute must be set.&#x20;
* Fata&#x6C;**:** Terminates the process if the value is missing or invalid.
* Ignore If Empt&#x79;**:** Skips the attribute during processing if no value is provided.
* Hash (SHA256)**:** Converts the value into a secure SHA256 hash.

<figure><img src="/files/pm8mARdebeCpxnGU6Ck2" alt=""><figcaption></figcaption></figure>

**Step 5.2.3:** Click **Settings** to configure these options.

<figure><img src="/files/hvg26s2mSLAQIE1HlKLZ" alt=""><figcaption></figcaption></figure>

**Step 5.2.4:** The **Attribute Settings** window opens.

* All previously selected attributes will appear ticked.
* You can uncheck any previously selected items or check the boxes for new attributes as needed.

<figure><img src="/files/WyapAOLlqbIOZ50veM4j" alt=""><figcaption></figcaption></figure>

**Step 5.2.5:** Click the **Data Type Conversion** drop-down menu.

* Select the appropriate conversion type from the available options:

<figure><img src="/files/SMIXcpYqgzcK8d3R2kiO" alt=""><figcaption></figcaption></figure>

| Data Type                | Description                                                                               |
| ------------------------ | ----------------------------------------------------------------------------------------- |
| No Conversion            | Indicates that there is no conversion required for the data type.                         |
| Convert to Boolean       | Converts the input data to Boolean.                                                       |
| Convert to Number        | Converts the input data to a number.                                                      |
| Convert to Array         | Converts the input data to Array.                                                         |
| Convert to Object Spread | Converts the JSON attributes under a parent level attribute to the root level attributes. |

**Step 5.2.6:** In the **Redaction** section, two checkboxes are available:

* **Ignore Redaction**: Skips applying redaction rules for this attribute.
* **Exclude from Request Body**: Prevents this attribute from being included in the outgoing request payload.

<figure><img src="/files/kiABV5NuActvoxxOFvQL" alt=""><figcaption></figcaption></figure>

**Step 5.2.7:** Once all the required fields are filled:

* Click **Confirm** to save the configuration.
* **Note**: To discard changes, click **Cancel**.

<figure><img src="/files/yCuLetejMPyJ6PZz9hnX" alt=""><figcaption></figcaption></figure>

**Step 6:** HTTP Headers (Optional)

**Step 6.1:** To add HTTP headers:

1. Click **Add Header**.
2. In the **Name** field, enter the header name.
3. In the **Value** field, enter the corresponding value.
4. Select the **Mandatory** checkbox if the header is required.

Note: To delete a header, click the **Delete** option next to it.

<figure><img src="/files/Ftz3yUvOZMIQx9SVQ3wO" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/kiRLLKl1CZSfOuhuLwtl" alt=""><figcaption></figcaption></figure>

**Step 7**: Connectors:

In the **Connectors** section, you will see two fields: **Name** and **Value**.

* The **Name** field is pre-filled.
* You need to enter the corresponding **Value** based on your configuration.

<figure><img src="/files/4b0VDnRphSOT0rBx67jM" alt=""><figcaption></figcaption></figure>

**Step 8:** Final Step

Once all the required fields are completed, scroll up and click **Save** to apply the changes.

<figure><img src="/files/Fz70Wq7I3vNpONO7VjOE" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FypeamAdyR6nIRKxMf49w%2FAdd%20a%20new%20Provider%20server%20side.mp4?alt=media&token=d8c52076-51f6-4ffd-989d-95ef22a4ba79>" %}


# Edit a Provider

### Introduction

You can edit the Provider details of an existing Provider.

### Procedure

To edit a Provider, perform the following steps:

**Step 1:** Select the Provider that you want to edit.

<figure><img src="/files/7z3NzzSNdGEZzDTBkrnT" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/VBL7jxdnfajrKWe2OtIw" alt=""><figcaption></figcaption></figure>

**Step 3:** Update the required fields as needed and click **Save** on the top-right to save the changes.

<figure><img src="/files/7mAMPJBDB0ESZ54w1QGC" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FqmfSkAlN52cpecg7mr5W%2FEdit%20a%20Provider.mp4?alt=media&token=da0c304b-3752-4b17-b0e9-a63cc51e64d5>" %}


# Delete a Provider

### Introduction

You can delete a particular Provider using this option.

### Procedure

To delete a Provider, perform the following steps:

**Step 1:** Select the Provider that you want to delete.

<figure><img src="/files/l2QDUK5QfAOyXfHJypn3" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Delete**.

<figure><img src="/files/K2DcXP2XIh1RipGcOLmE" alt=""><figcaption></figcaption></figure>

**Step 3:** A dialog box appears with the message: Do you wish to proceed?"

Click **Yes** to confirm and delete the Provider.

![](https://ingest-lab.netlify.app/images/providersimages/deleteconfirmatory.png)

**Step result**: The Provider is deleted successfully.

**Note**: You cannot delete a provider that includes provider dependencies with the other attributes. Only after deleting the dependent categories, you can delete the Provider successfully.

Even after deleting the dependencies, if you cannot delete the Provider, then you must Publish the relevant categories first and then perform the delete operation.

![](https://ingest-lab.netlify.app/images/providersimages/providerdependencies.png)


# Provider Version

## Overview

Every **Provider** includes a version number on the top-right corner of the screen. Once the Provider is published, the Version is set to 1. That is **Version 1**.

## Version Number Location

After subsequent edits and only after publishing, the version number keeps on updating to the latest version such as Version 2, version 3, and so on.

## Versioning Logic

When a new **Provider** is created and published for the first time, it is assigned **Version 1**.\
Every time the Provider is edited and then published again, the version number is incremented:\
Example: **Version 2**, **Version 3**, and so on.

<figure><img src="/files/WuaxzjUa7B88ia6m6sMV" alt=""><figcaption></figcaption></figure>

**Note 1:** For the default Providers, the version is always set to “1” because these are populated from the template.\
**Note 2:** Until the Provider is published, the status displays **Pending Publish**. Once the Provider is published in the staging or production environment, the status updates accordingly on the Providers screen.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FbK5PmEM8fulaEpU5PtSo%2FProviders%20versions.mp4?alt=media&token=999a29d9-bc22-454f-a5f5-4549b7bd0d24>" %}


# Triggers

The Triggers indicate when a particular tag is to be triggered based on the data inputs. The triggers are associated with different actions and events while performing the tasks. Some of the examples for triggers include Product View, View cart, Add to cart, View price, View item, View Payment, and so on. Also, the Qualification Criteria provides the additional criteria to indicate more specific instances of when the tag must be triggered. While the Triggers are mandatory, Qualification Criteria is optional.

<figure><img src="/files/d06HC0artjeUxmAmCZCH" alt=""><figcaption></figcaption></figure>

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Triggers section includes the following topics:

* [Triggers Screen](/tag-manager/triggers/triggers-screen)
* [Add a New Trigger (Browser)](/tag-manager/triggers/add-a-new-trigger-browser)
* [Add a New Trigger (Server)](/tag-manager/triggers/add-a-new-trigger-server)
* [Edit a Trigger](/tag-manager/triggers/edit-a-trigger)
* [Delete a Trigger](/tag-manager/triggers/delete-a-trigger)
* [Restore the Changes](/tag-manager/tags/restore-the-changes)
* [Trigger Version](/tag-manager/triggers/trigger-version)


# Triggers Screen

## Introduction

This section describes the Triggers screen UI elements.

## Procedures

#### Filter Triggers <a href="#filtertriggers" id="filtertriggers"></a>

Using the Filter Triggers option, you can filter the triggers based on the following types:

* Filter By Name: Filters the trigger based on the trigger name.
* Filter By Attribute Value: Filters the trigger based on Attribute Value.&#x20;
* Filter By Metadata Attribute: Filters the trigger based on Metadata Attribute.

<figure><img src="/files/ADuRpaN4pvIVKZCJwFZA" alt=""><figcaption></figcaption></figure>

#### Add Triggers

To create a new Trigger, click on the Add Trigger option located at the top-right corner of the screen.

<figure><img src="/files/hr2rHIjRnaaJLaH0zkJf" alt=""><figcaption></figcaption></figure>

#### Adjust Triggers View Per Page

**Triggers (21 of 21)**

This section shows the number of Triggers currently displayed out of the total available.

<figure><img src="/files/e8VKTHfrkiybTRf718hL" alt=""><figcaption></figcaption></figure>

This option indicates the number of Triggers currently displayed out of the total available Triggers.\
You can adjust the number of Triggers displayed per page using the dropdown menu located at the top-right corner of the screen.

* 50 per page: Displays up to 50 Triggers on the current page.
* 100 per page: Displays up to 100 Triggers on the current page.
* 200 per page: Displays up to 200 Triggers on the current page.

<figure><img src="/files/sm5fqKA4fpwzF93z9O60" alt=""><figcaption></figcaption></figure>

#### Filter By Data Elements <a href="#filterbydataelements" id="filterbydataelements"></a>

The Filter By Data Elements option allows to filter the triggers based on the Data Elements.

<figure><img src="/files/so1P5xPqetPJ73iccPOR" alt=""><figcaption></figcaption></figure>

You can select either the User-defined Data Element or Default Data Element in the Choose Data Elements screen.

![](https://ingest-lab.netlify.app/images/triggersimages/choosedataelements.png)

#### **Refresh the Triggers Screen**

The Refresh button allows you to reload the Triggers screen. If you create new Triggers or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

<figure><img src="/files/T9x2dBUbNvEfuWAoZSUe" alt=""><figcaption></figcaption></figure>

#### Default Triggers <a href="#defaulttriggers" id="defaulttriggers"></a>

Select the Default Triggers check box if you are selecting the default triggers for a particular tag.

<figure><img src="/files/32rxutaE34vnVv8ICGcG" alt=""><figcaption></figcaption></figure>

Red color indicates that the trigger is actively being recorded.

<figure><img src="/files/qVurkpFPQD5tIxgPzn40" alt=""><figcaption></figcaption></figure>

#### Additional Fields on the Triggers Screen

The following are the additional fields that appear on the Triggers screen.

<figure><img src="/files/Vi6IvuV3aNYDD3LtVTvV" alt=""><figcaption></figcaption></figure>

| Column Name | Description                                                                                                                                                                                               |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name        | Denotes the trigger Name.                                                                                                                                                                                 |
| Support     | <p>Denotes whether the trigger is a server-side or a browser-side setting. </p><ul><li>C: Denotes that the Trigger is client-side.</li><li>S: Denotes that the Trigger is server-side.</li></ul>          |
| Status      | <p>Denotes the status of the Trigger.<br>• Production: The Trigger is in Production status.<br>• Staging: The Trigger is in Staging status.<br>• Pending Publish: The Trigger is yet to be published.</p> |
| Created By  | Denotes the user who created the Trigger.                                                                                                                                                                 |
| Updated By  | Denotes the user who updated the Trigger.                                                                                                                                                                 |
| Updated On  | Denotes when the Trigger is last updated.                                                                                                                                                                 |

#### Steps to Add a Tag to the Trigger

Click Add Tag.

<figure><img src="/files/TcHpU5R4xqWcNqAioTlS" alt=""><figcaption></figcaption></figure>

The Select Provider panel will open on the right side of the screen.

* Use the search bar at the top of the panel to find a specific provider, o**r**
* Browse through the list of available providers and select the one you need.

<figure><img src="/files/eeeevCHq8dqP829FENkk" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F0nVqLkPCM4LSQfREIAs5%2FTriggers%20screen.mp4?alt=media&token=7d6911d1-2923-45b2-b412-dae868467376>" %}


# Add a New Trigger (Browser)

## Introduction

This document explains step by step how to add Triggers to the browser side. All the information required for Client-side or Browser-side configuratin.

on is fetched from the webpage or browser.

## Procedure

To add a new Trigger, perform the following steps:

**Step 1:** From the left navigation panel, select **Triggers**.

<figure><img src="/files/XSaw1ouKIjmuxWnqQ5VK" alt=""><figcaption></figcaption></figure>

**Step 2:** On the top-right corner of the screen, click the **Add Trigger** dropdown, then select **For Browser**.

<figure><img src="/files/QzSApnv1V0RBcHFdNwL8" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the **Info** section, locate the **Name** field and enter the appropriate name.

<figure><img src="/files/Y9i8CLA2gLUfuXQk5OXY" alt=""><figcaption></figcaption></figure>

**Step 4:** Under the **Event** section, click on **Data Element**.\
The **Select Data Element** panel opens on the right side of the screen.\
You can use the search bar to find a specific Data Element or browse through the list.

<figure><img src="/files/gArtJF1WmZ9pFFqKQucz" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/7j7N5lO7uHuZZ1NxIpqi" alt=""><figcaption></figcaption></figure>

**Step 5: Record Trigger**

Under the **Record Trigger** section, select the **Enable** checkbox.\
Once enabled, the **Namespace** field appears.\
Enter the appropriate namespace in the **Namespace** field.

<figure><img src="/files/72jf7dAtYN2hrNcTUCWn" alt=""><figcaption></figcaption></figure>

**Step 6:** Once all the required fields are filled, click **Save** to apply the changes.

<figure><img src="/files/CHelLol4ybMuISNIl0l8" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FCQnbPn86qFw2TcJEzX20%2FTriggers%20browser.mp4?alt=media&token=66d04b2c-e7ea-4b95-bca7-f1f9e2a95ad2>" %}


# Add a New Trigger (Server)

## Introduction

This document explains step by step how to add Triggers to the server side. All the required information is collected directly from the server.

## Procedure

To add a new server-side trigger, perform the following steps:

**Step 1:** From the left navigation panel, click **Triggers**.

<figure><img src="/files/SmKsDwZiLendV0trb7PQ" alt=""><figcaption></figcaption></figure>

**Step 2:** At the top-right side of the screen, click the **Add Server** dropdown menu, then choose **for** **Server.**

<figure><img src="/files/Uls0on1TCifJe5J9IAUZ" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the **Info** section, locate the **Name** field and enter the appropriate name.

<figure><img src="/files/FWqGiYWNzBNimIiLEUDq" alt=""><figcaption></figcaption></figure>

**Step 4:** Under the **Event** section, click **Add an Event**.\
The **Select an Event** panel opens on the right side of the screen.\
You can either use the search bar to find an event or select one from the list.

<figure><img src="/files/YMC9YH29IhSakjdYxllM" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/sqOooimapC7hId9pUe4K" alt=""><figcaption></figcaption></figure>

**Step 5: Record Trigger**

Under **Record Trigger**, check the **Enable** checkbox.\
The **Namespace** field will appear—enter the appropriate namespace in this field.

<figure><img src="/files/YGejk3UzacQmTeZrT05D" alt=""><figcaption></figcaption></figure>

**Step 6:** Once all the required fields are filled, click **Save**.

<figure><img src="/files/canAYFS8TidsLN43h0ck" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FfSiogZIxsvGVikqXCxrV%2FTriggers%20server.mp4?alt=media&token=bfccf59d-06a3-4711-966e-cde975fae979>" %}


# Edit a Trigger

## Introduction

You can edit the Trigger details of a particular Trigger that is already created.

## Procedure

To edit the Trigger in Tag Manager, perform the following steps:

**Step 1:** Select the Trigger that you want to edit.

<figure><img src="/files/ovx7ujw9Nk8jdTB3UHUY" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/atIO2eCmsCn176asD5Gd" alt=""><figcaption></figcaption></figure>

**Step 3:** You can edit the details in the *Info*, *Event*, and *Record Trigger* sections.

<figure><img src="/files/JzQqGaWyGafSGXMwyI8q" alt=""><figcaption></figcaption></figure>

**Step 4:** Click **Save** on the top right to save the changes.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FexLdYTOwtoiMttI58nLY%2FTriggers%20edit.mp4?alt=media&token=b4e3feb8-af6f-413e-bf3a-e4829c5a332e>" %}


# Delete a Trigger

## Introduction

You can delete a Trigger that is no longer needed by following the steps outlined in this document.

## Procedure

To delete a Trigger, perform the following steps:

**Step 1:** Select the Trigger that you want to delete.

<figure><img src="/files/jAcGAqz4ICjgbU8A4oFr" alt=""><figcaption></figcaption></figure>

**Step 2:** From the Actions drop-down menu on the top right corner, select **Delete**.

<figure><img src="/files/Raf0vcIUaT8j0V9chloU" alt=""><figcaption></figcaption></figure>

**Note**: You cannot delete the default triggers as the option for delete option is unavailable for default triggers.

**Step 3:** Click **Yes** on the confirmatory message that appears.

![](https://ingest-lab.netlify.app/images/triggersimages/deleteconfirmatory.png)

**Step Result**: The Trigger is deleted successfully.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FcVyv3nsvTwiddNmgrVqd%2Ftrigger%20delete.mp4?alt=media&token=5ce43ff6-0132-401b-990c-14ac097576f0>" %}


# Restore the changes

## Introduction

A deleted trigger can be restored using the **Restore** option.

## Procedure

To restore the changes, perform the following steps:

**Step 1:** Navigate to the Triggers screen to view the deleted trigger.

<figure><img src="/files/ifPQB3FTDptWUoUqhKgx" alt=""><figcaption></figcaption></figure>

**Step 2:** Select the deleted **Trigger**, and click **Restore** under the **Actions** drop-down on the top-right corner.

<figure><img src="/files/DLO35QGn4v2DQS8rWCTZ" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** in the Restore Trigger confirmatory dialog box that appears.

![](https://ingest-lab.netlify.app/images/triggersimages/restoretrigger.png)

**Step Result**: The Trigger is restored successfully.


# Trigger Version

### Overview

Every Trigger includes a version number displayed in the top-right corner of the screen. Once the Trigger is published, the version is set to 1 — that is Version 1.

### Version Number Location

After subsequent edits, and only after publishing, the version number is updated to the latest version, such as Version 2, Version 3, and so on.

<figure><img src="/files/ITa1XSpupTf5DEwHG9Oq" alt=""><figcaption></figcaption></figure>

### Versioning Logic

When a new Trigger is created and published for the first time, it is assigned Version 1.\
Every time the Trigger is edited and then published again, the version number is incremented:\
Example: Version 2, Version 3, and so on.

**Note 1:** For default Triggers, the version is always set to **1** because these are populated from the template.\
**Note 2:** Until the Trigger is published, the status displays **Pending Publish**. Once the Trigger is published in the staging or production environment, the status updates accordingly on the Triggers screen.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fa8ZpiIW4njZuS86qj1rW%2FTrigeer%20versioning.mp4?alt=media&token=5e50df9d-a15d-4965-9cb6-1da1f49fc31c>" %}


# Record Trigger Feature

## Introduction

To monitor and capture events in your triggers, you can enable the recording feature. This will ensure that every event occurring within the triggers is saved and marked as recorded for future reference.

## Procedure

You can enable the recording feature for triggers by following these steps.

**Note:** You can create Record Triggers for both **Server** and **Browser**.

**Step 1:** Click **Add Trigger**.

<figure><img src="/files/z1j1J1X4XWZNUAABur9e" alt=""><figcaption></figcaption></figure>

**Step 2:** Click for **Browser**.

<figure><img src="/files/JS2Tv1Z3T3dGyZhA36YJ" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the **Info** section, click the **Name** field and enter an appropriate name for your Record Trigger.

<figure><img src="/files/wqqsiwd7aoRgXa0wYnwa" alt=""><figcaption></figcaption></figure>

**Step 4:** Under **Data Element**, click **Add Data Element**. The **Select Data Element** panel will open on the right side. You can either search for a particular data element by typing its name in the search bar or select it from the available list.

<figure><img src="/files/FOjCIoQHsngcdvaqmbyZ" alt=""><figcaption></figcaption></figure>

**Step 5:** Under the *Include these values* section, click *Add Value* and enter the value you want to include. Then, click the plus symbol.

<figure><img src="/files/CMBxOTvMkqi9iplqdmXs" alt=""><figcaption></figcaption></figure>

**Step 6:** After clicking the **plus symbol**, two checkboxes will appear:

* **Case Sensitive** and
* **Exact Match**

Click both checkboxes to apply these settings.

<figure><img src="/files/lAcXTVCWQA4XOc5drYOw" alt=""><figcaption></figcaption></figure>

**Step 7:** Under **Exclude these values**, you can give values to exclude.

Under the **Exclude these values**, click *Add Value* and enter the value you want to exclude. Then, click the plus symbol.

**Step 8:** Under the **Record Trigger** section, you will find the **Enable** checkbox. Check the box, and then the **Namespace** section will appear. Provide the appropriate namespace value.

<figure><img src="/files/ezxW0HtEHvkLbMzlgvrq" alt=""><figcaption></figcaption></figure>

**Step 9:** Click Save.&#x20;

**Step 10:** **Red color** indicates that the trigger is actively being recorded.&#x20;

<figure><img src="/files/5tQIVyFT6l2NwqgOfTyO" alt=""><figcaption></figcaption></figure>

**Note:** The same steps apply for server-side triggers.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FipfwLBaA5QC5kZ4YYRcq%2FRecord%20Trigger%20Feature%20Trigers%20final.mp4?alt=media&token=79d85b13-8ac3-4127-ba91-84c97fe69ced>" %}


# Qualification Criteria

The Qualification Criteria are similar to Triggers that are performed to trigger the tag for a specific condition. The Ingest Labs triggers the tag when the Qualification Criteria is met for either browser-side tags or server-side tags.

<figure><img src="/files/z6kv54OVkMQYB7GPEXv0" alt=""><figcaption></figcaption></figure>

**Note**: The Qualification Criteria evaluates the conditions to trigger a tag. For a particular tag to trigger, the qualification criteria is optional. However, when the Qualification Criteria is provided along with the Triggers, then the conditions for Triggers and Qualification Criteria must return true. Only then the tag gets triggered.

Also, if the Qualification Criteria is not defined, the tag is triggered only when the triggers are invoked.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Qualification Criteria section includes the following topics:

* [Qualification Criteria Screen](/tag-manager/qualification-criteria/qualification-criteria-screen)
* [Add a New Qualification Criteria (Browser)](/tag-manager/qualification-criteria/add-a-new-qualification-criteria-browser)
* [Add a New Qualification Criteria (Server)](/tag-manager/qualification-criteria/add-a-new-qualification-criteria-server)
* [Edit a Qualification Criteria](/tag-manager/qualification-criteria/edit-a-qualification-criteria)
* [Delete a Qualification Criteria](/tag-manager/qualification-criteria/delete-a-qualification-criteria)
* [Restore the Changes](/tag-manager/tags/restore-the-changes)
* [Qualification Criteria Version](/tag-manager/qualification-criteria/qualification-criteria-version)

[<br>](https://ingest-lab.netlify.app/tagmanager/triggers/triggerversion/)


# Qualification Criteria Screen

## Introduction

This document provides an overview of the Qualification Criteria UI screen elements.

## Procedure

### Qualification Criteria (23 of 23)

This option indicates the number of Qualification Criteria currently displayed out of the total available Qualification Criteria.

<figure><img src="/files/wLO5Yof4PnPUP2SrzSn4" alt=""><figcaption></figcaption></figure>

### Adjust Qualification Criteria View Per Page

This option indicates the number of Qualification Criteria currently displayed out of the total available Qualification Criteria.\
You can adjust the number of Qualification Criteria displayed per page using the dropdown menu located at the top-right corner of the screen.

* **50 per page**: Displays up to 50 Qualification Criteria on the current page.
* **100 per page**: Displays up to 100 Qualification Criteria on the current page.
* **200 per page**: Displays up to 200 Qualification Criteria on the current page.

<figure><img src="/files/rYY6ROw80u5jknlG8KRJ" alt=""><figcaption></figcaption></figure>

### Add Qualification Criteria <a href="#filterqualificationcriteria" id="filterqualificationcriteria"></a>

Click the **Qualification Criteria** dropdown. You will see two options: **For Server** and **For Browser**. Select the required option.

<figure><img src="/files/Nx62bMsQwWhw39DQ5915" alt=""><figcaption></figcaption></figure>

### Filter Qualification Criteria <a href="#filterqualificationcriteria" id="filterqualificationcriteria"></a>

The **Filter Qualification Criteria** is based on the following types:

* **Filter By Name**: Filters the Qualification Criteria based on the trigger name.
* **Filter By Attribute Value**: Filters the Qualification Criteria based on Attribute Value.
* **Filter By Metadata Attribute**: Filters the Qualification Criteria based on Metadata Attribute.

<figure><img src="/files/saSeUFyEPSxMXycF1Jxg" alt=""><figcaption></figcaption></figure>

### Filter By Data Elements <a href="#filterbydataelements" id="filterbydataelements"></a>

The **Filter by Data Elements** option filters the Qualification Criteria based on the Data Elements.

Click **Filter by Data Elements**.

<figure><img src="/files/pMGh7yfuV5IjxeKZI2fD" alt=""><figcaption></figcaption></figure>

The **Choose Data Elements** panel opens on the right side of the screen.

You will see two tabs: **User-defined** and **Default**.

<figure><img src="/files/xYgDLSaCEo9IL6mxMWzJ" alt=""><figcaption></figcaption></figure>

Select the required Data Elements from either tab or use the **search bar** to find specific Data Elements.

<figure><img src="/files/gUlnNt4T8Ty41qBFRZTi" alt=""><figcaption></figcaption></figure>

You can select multiple Data Elements as needed.

After selecting the Data Elements, click **Done** to apply the filter.

<figure><img src="/files/uhzmNfwq891TkyOs1RV4" alt=""><figcaption></figcaption></figure>

#### Note:  <a href="#resetfilters" id="resetfilters"></a>

Deselect: To remove a selected Data Element, click the small x icon next to it.

Click the **Refresh.**

A **Fetching Data Elements…** message appears while the system retrieves and displays the updated data.

<figure><img src="/files/WrBXCakuD9e9CH2IrSNK" alt=""><figcaption></figcaption></figure>

**Reset Filters:**

Click this to clear all applied filters and restore the default view.

<figure><img src="/files/ayCOQaH0zpsgjob27HxB" alt=""><figcaption></figcaption></figure>

### The following are the additional fields that appear on the Qualification Criteria screen.

<figure><img src="/files/9UJx4Zp7bk2sGWeZpe4I" alt=""><figcaption></figcaption></figure>

| Column Name | Description                                                                                                                                                                                                                                                           |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**    | Denotes the Qualification Criteria Name.                                                                                                                                                                                                                              |
| **Support** | <p>Denotes whether the Qualification Criteria is a server-side or a browser-side setting. </p><ul><li>C stands for Client-side</li><li>S stands for Server-side.</li></ul>                                                                                            |
| Status      | <p>Denotes the status of the Qualification Criteria.<br>• Production: The Qualification Criteria is in Production status.<br>• Staging: The Qualification Criteria is in Staging status.<br>• Pending Publish: The Qualification Criteria is yet to be Published.</p> |
| Created By  | Denotes the user who created the Qualification Criteria.                                                                                                                                                                                                              |
| Updated By  | Denotes the user who updated the Qualification Criteria.                                                                                                                                                                                                              |
| Updated On  | Denotes when the Qualification Criteria is last updated.                                                                                                                                                                                                              |
| Add Tag     | You can create the tag using this option from the Qualification Criteria.                                                                                                                                                                                             |

### Add Tag

To add a tag, follow these steps:

Click **Add Tag**.

<figure><img src="/files/fyWmF2SfOUzDlwxwDAmV" alt=""><figcaption></figcaption></figure>

The **Select Provider** panel opens on the right side of the screen.

<figure><img src="/files/0vplFQsRLLm2tTVGl94M" alt=""><figcaption></figcaption></figure>

In the panel, you can select a provider from the list or use the **search bar** to find a specific provider.

<figure><img src="/files/UkPkbYBLFeAju8y6VZl9" alt=""><figcaption></figcaption></figure>

After selecting the required provider, complete the tagging process as needed. For further details, refer to the *Tag* section.

{% file src="/files/dyTJC3qIO8uU7HzuxpeI" %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fn20ZeerMlulrip13Q4c6%2FQualification%20criteria%20screen.mp4?alt=media&token=4a6bf0d5-4dea-4755-acfa-ca80ece230ea>" %}


# Add a New Qualification Criteria (Browser)

## Introduction

This document explains step by step how to add Qualification Criteria to the browser side. All the information required for Client-side or Browser-side configuration is provided.

## Procedure

**Step 1:** From the left navigation panel, select **Qualification Criteria**.

<figure><img src="/files/Kz12aYrwDyIYtvvOSQFM" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Add Qualification Criteria** drop-down and select **For Browser**.

<figure><img src="/files/JOhQtTSwTwdORzJ8xDTM" alt=""><figcaption></figcaption></figure>

**Step 3:** Under **Info**, enter the Qualification Criteria name in the **Name** field.

<figure><img src="/files/g0EYgcUTgHdkGT5IRTUn" alt=""><figcaption></figcaption></figure>

**Step 4:** Under **Data Elements**, click **Add Data Element**.

<figure><img src="/files/14dYv2AhHKjoTRGbFAli" alt=""><figcaption></figcaption></figure>

The ***Select Data Element*** panel opens on the right side. You can choose a data element from the ***User Defined*** or ***Default*****&#x20;tabs**, or use the search bar to find a specific data element.

<figure><img src="/files/jt9Rwylqtw0cdYRrFtEv" alt=""><figcaption></figcaption></figure>

**Step 5:** Under the ***Include these values*** section, click ***Add Value*** and enter the value you want to include. Then, click the **plus** symbol.

<figure><img src="/files/TsvKexoLx30qLnt8b9Pq" alt=""><figcaption></figcaption></figure>

**Step 5.1:**

* **Case Sensitive**: This option indicates if the value entered is Case sensitive to further trigger the tag.
* **Exact Match**: This option indicates if the value matches exactly to trigger the tag.

<figure><img src="/files/Ht1Xx2RZRdTvTxcecd9N" alt=""><figcaption></figcaption></figure>

**Step 6:** Under ***Exclude these values***, type the value you want to remove, then click the plus icon to exclude it.

<figure><img src="/files/lcAJGOzYN0TCRXCQsRBk" alt=""><figcaption></figcaption></figure>

**Step 6.1:**&#x20;

• **Case Sensitive**: This option indicates if the value entered is Case sensitive to further trigger the tag.\
• **Exact Match**: This option indicates if the value exactly matches to trigger the tag.

<figure><img src="/files/jlgJDgRHU8twxUfgp8IR" alt=""><figcaption></figcaption></figure>

**Step 6:** Click **Save** on the top right to save the Qualification Criteria details.+

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FNVgfcpNA7EivPxpiOlhh%2FAdd%20a%20New%20Qualification%20Criteria%20(Browser).mp4?alt=media&token=2fec4b6d-b0d4-488b-bb1e-d9c14b464351>" %}


# Add a New Qualification Criteria (Server)

## Introduction

This document explains step by step how to add Qualification Criteria to the server side. All the information required for Client-side or Server-side configuration is provided.

## Procedure

**Step 1:** From the left navigation panel, select **Qualification Criteria**.

<figure><img src="/files/9XuaoBFxGUJcbsrFJNFx" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Add Qualification Criteria** dropdown and select **For Server**.

<figure><img src="/files/GeS7W2GIyAZJiDTP6yqG" alt=""><figcaption></figcaption></figure>

**Step 3:** Under **Info**, enter the **Qualification Criteria Name** in the **Name** field.

<figure><img src="/files/1ba3Rspy4VDAP8tiRFpt" alt=""><figcaption></figcaption></figure>

**Step 4:** Under **Data Element**, click **Add Data Element**.

<figure><img src="/files/DHrTHw2V86NbFuKP7aEc" alt=""><figcaption></figcaption></figure>

The **Select Data Element** panel opens on the right side. Choose from the **User Defined** or **Default** tabs or use the search bar to find a Data Element.

<figure><img src="/files/58olYCgqY3JvABQ0Rl8m" alt=""><figcaption></figcaption></figure>

**Step 5:** Under the ***Include these values*** section, click ***Add Value*** and enter the value you want to include. Then, click the **plus** symbol.

<figure><img src="/files/WTLew035wdJ98nkXckld" alt=""><figcaption></figcaption></figure>

**Step 5.1:**

* **Case Sensitive**: This option indicates if the value entered is Case sensitive to further trigger the tag.
* **Exact Match**: This option indicates if the value matches exactly to trigger the tag.

<figure><img src="/files/SCnPBXbR1mAnmpxHLbsN" alt=""><figcaption></figcaption></figure>

**Step 6:** Under ***Exclude these values***, type the value you want to remove, then click the plus icon to exclude it.

<figure><img src="/files/qpHvHpDv6nXPGFBLfrXb" alt=""><figcaption></figcaption></figure>

**Step 6.1:**&#x20;

• **Case Sensitive**: This option indicates if the value entered is Case sensitive to further trigger the tag.\
• **Exact Match**: This option indicates if the value exactly matches to trigger the tag.

<figure><img src="/files/FJpXaEd9o5YTCfOHDOQp" alt=""><figcaption></figcaption></figure>

**Step 7:** Click **Save** on the top right to save the Qualification Criteria details.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F2NXKWbgdkRA5ETNKuWOt%2FAdd%20a%20New%20Qualification%20Criteria%20(Server).mp4?alt=media&token=0d100ade-377d-49f7-8bbb-4d7aa7e9327f>" %}


# Edit a Qualification Criteria

## Introduction

You can edit the details of an existing Qualification Criteria using this option.

## Procedure

To edit a Qualification Criteria in Tag Manager, perform the following steps:

**Step 1:** Select the Qualification Criteria that you want to edit.

<figure><img src="/files/KfY0LuJ3TsrMALcWeOb8" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/p8vdeJOlwCJRGUBUJ5Qr" alt=""><figcaption></figcaption></figure>

**Step 3:** Edit the required fields, and once done, click **Save**.

<figure><img src="/files/96aCGB0yc7DeImxLtYB6" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FNl6Wi66MBtzddtzY4h8H%2FEdit%20a%20Qualification%20Criteria.mp4?alt=media&token=f840b9ef-e848-4f6c-ad9f-0105cb1a60c8>" %}


# Delete a Qualification Criteria

## Introduction

This document provides step-by-step instructions for deleting a Qualification Criteria.

## Procedure

**Step 1:** Select the Qualification Criteria that you want to delete.

<figure><img src="/files/Kri4FR5HakxMtgi7s7Zb" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Delete**.

<figure><img src="/files/w7OEtSVQ4gE8cW6qPP1s" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** on the confirmatory message that appears.

![](https://ingest-lab.netlify.app/images/qualificationcriteriaimages/deleteconfirmatory.png)

**Step Result**: The Qualification Criteria is deleted successfully.

![](https://ingest-lab.netlify.app/images/qualificationcriteriaimages/triggerdependencies.png)

**Note:** You cannot delete a Qualification Criteria if there are any dependencies in the tag. Only after deleting the dependent categories, you can delete the Qualification Criteria successfully. Even after deleting the dependencies, if you cannot delete the Qualification Criteria, then you must Publish the relevant categories first and then perform the delete operation.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FTfH1c323VKYF7gA7I7Lm%2FDelete%20a%20Qualification%20Criteria.mp4?alt=media&token=74b26e60-8040-4e2a-a08d-716485bff155>" %}


# Restore the Changes

## Introduction

Deleted qualification criteria can be restored using the **Restore** option.

## Procedure

To restore deleted qualification criteria, perform the following steps:

**Step 1:** Navigate to the Qualification Criteria screen to view the deleted Qualification Criteria.

<figure><img src="/files/4m59WO0QrxwE26tB4lBW" alt=""><figcaption></figcaption></figure>

**Step 2:** Select the Qualification Criteria you want to restore.

<figure><img src="/files/moBalPcYwQU0KirKLE2I" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Restore** in the **Actions** drop-down on the top right corner.

<figure><img src="/files/VgB7CPqrXtgHnbwVUlek" alt=""><figcaption></figcaption></figure>

**Step 4:** Click **Yes** in the Restore confirmatory dialog box that appears.

![](https://ingest-lab.netlify.app/images/qualificationcriteriaimages/restoreconfirmatory.png)

**Step Result**: The Qualification Criteria is restored successfully.


# Qualification Criteria Version

## **Overview**

Every **Qualification Criteria** includes a version number on the top-right corner of the screen. Once the **Qualification Criteria** is published, the Version is set to **1**. That is **Version 1**.

### Version Number Location

After subsequent edits and only after publishing, the version number keeps updating to the latest version such as **Version 2**, **Version 3**, and so on.

### Versioning Logic

When a new **Qualification Criteria** is created and published for the first time, it is assigned **Version 1**.\
Every time the **Qualification Criteria** is edited and then published again, the version number is incremented:\
Example: **Version 2**, **Version 3**, and so on.

<figure><img src="/files/b6EM2HE6MpN4lmAVi45b" alt=""><figcaption></figcaption></figure>

**Note 1:** For the default **Qualification Criteria**, the version is always set to **“1”** because these are populated from the template.\
**Note 2:** Until the **Qualification Criteria** is published, the status displays **Pending Publish**. Once the **Qualification Criteria** is published in the staging or production environment, the status updates accordingly on the **Qualification Criteria** screen.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FVEmXkPQ5x1KkSPlWXiLq%2FQualification%20Criteria%20Version.mp4?alt=media&token=1f032657-92fb-4878-8f12-3524c40019b8>" %}


# Transformers

The Transformers or the transformation functions are the main building blocks of data while implementing tags. The data layer value may return an object and needs to convert it into a variety of other formats to be used within tags or provider attributes.

The standard approach is to create multiple Data elements and format the value each time while creating other Tag Managers. This results in the same data being redefined in various occurrences. However, if the source data changes, then you must update all the instances where it is being read and transformed to different formats.

A transformation function can accept any number of data elements as inputs, format the data, and return it in a different format as required for a dynamic template parameter.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Transformers section includes the following topics:

* [Transformers Screen](/tag-manager/transformers)
* [Add a New Transformer (Browser)](/tag-manager/transformers/add-a-new-transformer-browser)
* [Add a New Transformer (Server)](/tag-manager/transformers/add-a-new-transformer-server)
* [Edit a Transformer](https://ingest-lab.netlify.app/tagmanager/transformers/editatransformer/)
* [Delete a Transformer](/tag-manager/transformers/delete-a-transformer)
* [Restore the Changes](/tag-manager/tags/restore-the-changes)
* [Transformer Version](/tag-manager/transformers/transformers-version)


# Transformers Screen

## Introduction

This section describes the Transformers UI screen elements.

## Procedure

### **Transformers (25 of 25)**

*This option indicates the number of Transformers currently displayed out of the total available Transformers.*

<figure><img src="/files/y39AChwALDUMOSNP7jvY" alt=""><figcaption></figcaption></figure>

### Adjust Transformers View Per Page

This option indicates the number of Transformers currently displayed out of the total available Transformers.\
You can adjust the number of Transformers displayed per page using the dropdown menu located at the top-right corner of the screen.

* **50 per page:** Displays up to 50 Transformers on the current page.
* **100 per page:** Displays up to 100 Transformers on the current page.
* **200 per page:** Displays up to 200 Transformers on the current page.

<figure><img src="/files/zepdXx5XUB0rMhqWNHBu" alt=""><figcaption></figcaption></figure>

### Add Transformers

Click the **Transformers** dropdown. You will see two options: **For Server** and **For Browser**. Select the required option.

<figure><img src="/files/98JRyiw08u0WFeBIi6pV" alt=""><figcaption></figcaption></figure>

### Filter Transformers

The **Filter Transformers** option is based on the following types:

* **Filter By Name:** Filters the Transformers based on the trigger name.
* **Filter By Attribute Value:** Filters the Transformers based on Attribute Value.
* **Filter By Metadata Attribute:** Filters the Transformers based on Metadata Attribute.

<figure><img src="/files/bXzY72KF2Y6f0aeCq5sf" alt=""><figcaption></figcaption></figure>

Click the **Refresh.**

A **Fetching Data Elements…** message appears while the system retrieves and displays the updated data.

<figure><img src="/files/yi7S281Rdww2WrIz3vIR" alt=""><figcaption></figcaption></figure>

### The following are the additional fields that appear on the Transformers screen.

<figure><img src="/files/8tfVpwcOrBI9RZ0Rs06Y" alt=""><figcaption></figcaption></figure>

| Column Name    | Description                                                                                                                                                                                                    |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**       | Denotes the Transformer Name.                                                                                                                                                                                  |
| **Type**       | Denotes whether the Transformer is a server-side or a browser-side setting.                                                                                                                                    |
| **Status**     | <p>Denotes the status of the Transformer.<br>• Production: The Transformer is under production.<br>• Staging: The Transformer is in Staging.<br>• Pending Publish: The Transformer is yet to be published.</p> |
| **Created By** | Denotes the user who created the Transformer.                                                                                                                                                                  |
| **Updated By** | Denotes the user who updated the Transformer.                                                                                                                                                                  |
| **Updated On** | Denotes when the Transformer is last updated.                                                                                                                                                                  |

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FmCAbpOvUF72SEi1cjhpH%2FTransformers%20Screen.mp4?alt=media&token=51f55aaf-7c28-48b0-af22-e06addcd07e6>" %}


# Add a New Transformer (Browser)

## Introduction

This document explains step by step how to add Transformers to the browser side.  All the information required for client-side or browser-side configuration is provided.

### Procedure

To add a new Transformer in Tag Manager, perform the following steps:

**Step 1:**  From the left navigation panel, select **Transformers**.

<figure><img src="/files/fbwJsOB8JM1ahtutmJkK" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Add Transformer** drop-down and select **For Browser**.

<figure><img src="/files/hSZe373Rrse3DWmqkYZT" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the **Info** section, enter the function name in the **Function Name field**.

<figure><img src="/files/IJzIQImGdE4OnvcTeJC1" alt=""><figcaption></figcaption></figure>

**Step 4:** Enter the Description in the **Description** field.

<figure><img src="/files/sYUNhlPdv9G8nVjqNPJk" alt=""><figcaption></figcaption></figure>

**Step 5:** In the ***Function Arguments*** section, click ***Add Agreement***.

<figure><img src="/files/DPVQWLC8qDezVfTaeoK3" alt=""><figcaption></figcaption></figure>

**Step 5.1:** In the ***Name*** field, enter the appropriate name.

<figure><img src="/files/hAEmdcNIYOrZex0urVKq" alt=""><figcaption></figcaption></figure>

**Step 5.2:** Under ***Value***, click ***Select Data Element***.

<figure><img src="/files/S2m5EL3s0qgZNuRUI1ZC" alt=""><figcaption></figcaption></figure>

**Step 5.3:** The *Select Data Element* panel opens on the right side. Two tabs are available — *User-defined* and *Default*. You can select a data element from these tabs or use the search bar to find one.

<figure><img src="/files/b7MRGE6c3SinhW3O5EYB" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/AU3CT6BUvAqtUhahKbDV" alt=""><figcaption></figcaption></figure>

**Note:** Click the selected argument data element value. The data element details will appear in the right panel.

<figure><img src="/files/DTiyKHGSN0q7BVRZqjXE" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/vfqkocHFo7ggRNsrvUpk" alt=""><figcaption></figcaption></figure>

Note: To clear the selected data element value, click the small **X** icon next to it.

<figure><img src="/files/gyeivPBa3eKwmukFmOXT" alt=""><figcaption></figcaption></figure>

**Step 5.4:** Select the checkboxes for ***Mandatory*** and *URL Encode*, if required.

<figure><img src="/files/riCqzCgCsGaDB8FESUcx" alt=""><figcaption></figcaption></figure>

**Note:** To delete the Argument, click the **Delete** icon on the right-hand corner of the screen.

<figure><img src="/files/KuelUmOo465DHJFaQ8Lr" alt=""><figcaption></figcaption></figure>

**Step 6:** To access the Argument, enter the code in the Code section. You can also Test the function using the Test Function tab on the right-hand corner of the screen.

**Step 7:** Click the **Full Screen** icon ![](/files/mVHtTJpF7Z0kEKfWkIfY) to expand the code and view it in full screen mode.

![](https://ingest-lab.netlify.app/images/transformersimages/code.png)

**Step 8:** Click **Test Function**. The **Test Function** panel opens.

<figure><img src="/files/kWWJy4KOoz7G4lTIbcnj" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/bAakr1WhzozGxOPVkVMC" alt=""><figcaption></figcaption></figure>

**Step 9:** Click the **Select** dropdown and choose an input type:

* **Number** — Use this option if your function requires a numeric input.
* **String** — Use this option if your function requires text input.
* **Boolean** — Use this option if your function requires a true/false value.
* **JSON** — Use this option if your function requires structured data in JSON format.

<figure><img src="/files/joPRAlmmni23N1vRHpFk" alt=""><figcaption></figcaption></figure>

**Step 10:** Enter the **Argument value** that corresponds to the selected input type.

<figure><img src="/files/rtJEN5ren2DjhC0tziwn" alt=""><figcaption></figcaption></figure>

**Step 11:** Navigate to the **Output** tab to view the result of the executed function.<br>

<figure><img src="/files/Vq11JoSvjQilgzKMimGC" alt=""><figcaption></figcaption></figure>

**Step 12:** Click **Save** to save the Transformers details.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FHn9f3BPyOSIUbO0a559q%2FAdd%20a%20New%20Transformer%20(Browser).mp4?alt=media&token=3309b733-8fbc-4fc8-861b-136c334265a1>" %}


# Add a New Transformer (Server)

## Introduction&#x20;

This document explains step by step how to add Transformers to the server side. All the information required for client-side or server-side configuration is provided.

## Procedure

To add a new Transformer in Tag Manager, perform the following steps:

**Step 1:** In the navigation panel, click ***Transformers*****.**

<figure><img src="/files/vyy1czt5MLst2hDJvrfK" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the ***Add Transformer*** drop-down and select **For Server**.

<figure><img src="/files/IxWawkRph9WHLaBFZMl2" alt=""><figcaption></figcaption></figure>

**Step 3:** Under the ***Info*** section, in the ***Function Name*** field, enter the appropriate name.

**Note**: The Function name must always start with an alphabet, and can only contain letters, numbers and underscores.

<figure><img src="/files/qfeZKW9teNxx5wt03w0A" alt=""><figcaption></figcaption></figure>

**Step 4:** In the ***Description*** field, enter an appropriate description.

<figure><img src="/files/HQRdqhc82ArnpVEq5ZAD" alt=""><figcaption></figcaption></figure>

**Step 5:** Under the ***Function Arguments*** field, click **Add&#x20;*****Arguments*****.**

<figure><img src="/files/ZjS4tcOA8SOZPPqQ9t8a" alt=""><figcaption></figcaption></figure>

**Step 5.1:** In the ***Name*** field, enter the appropriate name.

<figure><img src="/files/8NGjWg0EY420GjftYl8I" alt=""><figcaption></figcaption></figure>

**Step 5.2:** Under the ***Value*** field, click ***Select Data Element***.

<figure><img src="/files/7SmQ4OF2XIGrWe97qDz0" alt=""><figcaption></figcaption></figure>

The ***Select Data Element*****&#x20;panel** opens on the right side.

Two tabs are available:

* User-defined
* Default

You can select a data element from these tabs or use the search bar.

<figure><img src="/files/4FqTlLaphuAQM3o1hhkZ" alt=""><figcaption></figcaption></figure>

**Note:** Click the selected argument data element value. The data element details will appear in the right panel.

<figure><img src="/files/5m0zscyHFmoIkD6Cnwb7" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/ti4zJPhyeAEdJf0LTPix" alt=""><figcaption></figcaption></figure>

**Note:** To clear the selected data element value, click the small **X** icon next to it.

<figure><img src="/files/JzFxVTnBovVv2SxfQVgS" alt=""><figcaption></figcaption></figure>

**Step 5.3:** The following checkboxes are available:

* Mandatory: Select this checkbox to make the argument required.
* URL Encode: Select this checkbox to encode the value for safe URL transmission.
* Hash (SHA256): Select this checkbox to hash the value using the SHA256 algorithm.

<figure><img src="/files/pYBTJFkIobCfEXbaexv4" alt=""><figcaption></figcaption></figure>

Note: To delete the Argument, click the **Delete** icon on the right-hand corner of the screen.

**Step 6:** To access the Argument, enter the code in the Code section. You can also test the function using the **Test Function** tab on the right-hand corner of the screen.

**Step 7:** Click the **Full Screen** icon ![](/files/mVHtTJpF7Z0kEKfWkIfY) to expand the code and view it in full screen mode.

![](https://ingest-lab.netlify.app/images/transformersimages/codeserver.png)

**Step 8:** Click **Test Function**. The **Test Function** panel opens.

<figure><img src="/files/KKz8s8Mh8AlBV7Km4hr7" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/gdowqKoitg76KsGVfbcA" alt=""><figcaption></figcaption></figure>

**Step 9:** Click the **Select** dropdown and choose an input type:

* **Number** — Use this option if your function requires a numeric input.
* **String** — Use this option if your function requires text input.
* **Boolean** — Use this option if your function requires a true/false value.
* **JSON** — Use this option if your function requires structured data in JSON format.

<figure><img src="/files/lTEgQWaZiycoP5sPOieN" alt=""><figcaption></figcaption></figure>

**Step 10:** Enter the **Argument value** that corresponds to the selected input type.

<figure><img src="/files/Sj2mB19CPdzIT1JRIfJq" alt=""><figcaption></figcaption></figure>

**Step 11:** Navigate to the **Output** tab to view the result of the executed function.

<figure><img src="/files/xOibjAEgYqyjCExfUHki" alt=""><figcaption></figcaption></figure>

**Step 12:** Click **Save** to save the Transformer details.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FghtPex7zk2Yz4Pg6ZDh4%2FAdd%20a%20New%20Transformer%20(Server).mp4?alt=media&token=a405af97-42a2-4d95-8b71-3d4a74ce345c>" %}


# Edit a Transformer

## Introduction

You can edit the details of an existing transformer using this option.

## Procedure

To edit the Transformer, perform the following steps:

**Step 1:** Select the Transformer that you want to edit.

<figure><img src="/files/ZEJPD9UqyOvc3wrQsRQA" alt=""><figcaption></figcaption></figure>

**Step 2:** From the **Actions** drop-down menu on the top right corner, select **Edit**.

<figure><img src="/files/FuDHjtQI5M9zduhY3utL" alt=""><figcaption></figcaption></figure>

**Step 3:** You can edit the details in the Info, Function Arguments, and Code sections.

**Step 4**: Click **Save** on the top right to save the changes.

<figure><img src="/files/PebaRcncsWAufqyKEaRQ" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F4feh08fRRjdLP0QNRh9S%2FEdit%20a%20Transformer.mp4?alt=media&token=79f90ad1-cc70-4c05-98b6-ae8f133a9c46>" %}


# Delete a Transformer

## Introduction

You can delete a particular Transformer.

## Procedure

To delete a Transformer in Tag Manager, perform the following steps:

**Step 1:** Select the Transformer that you want to delete.

<figure><img src="/files/uZJj1tIpbRG0S5lsNfgF" alt=""><figcaption></figcaption></figure>

**Step 2:** In the top right corner, click the ***Actions*** drop-down and select ***Delete***.

<figure><img src="/files/DZ7NsI0XmQE9HHgMRaq7" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** on the confirmatory message that appears.

![](https://ingest-lab.netlify.app/images/transformersimages/deleteconfirmatory.png)

**Step Result**: The Transformer is deleted successfully.

**Note**: The following error occurs if there are any dependencies for the transformers in tags.

![](https://ingest-lab.netlify.app/images/transformersimages/dependencies.png)

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fx2CnowCzQiygQCy89VBw%2FDelete%20a%20Transformer.mp4?alt=media&token=6edff1b8-f347-4ecb-a676-e53c0180200c>" %}


# Restore the Changes

## Introduction

A deleted transformer can be restored using the **Restore** option.

## Production

To restore a deleted transformer, perform the following steps:

**Step 1:** Navigate to the Transformers screen to view the deleted transformer.

**Step 2:** Select the Transformer and click **Restore** in the **Actions** drop-down on the top right corner.

![restorethechanges](https://ingest-lab.netlify.app/images/transformersimages/restore.png)

**Step 3:** Click **Yes** in the Restore confirmatory dialog box that appears.

![restorethechanges](https://ingest-lab.netlify.app/images/transformersimages/restoreconfirmatory.png)

**Step Result**: The Transformer is restored successfully.


# Transformers Version

## Overview

Every **Transformer** includes a version number on the top-right corner of the screen. Once the Transformer is published, the version is set to 1 — that is Version 1.

## Version Number Location

After subsequent edits and only after publishing, the version number keeps updating to the latest version, such as Version 2, Version 3, and so on.

<figure><img src="/files/YQf7KspanPNLqIkWmMIC" alt=""><figcaption></figcaption></figure>

## Versioning Logic

When a new Transformer is created and published for the first time, it is assigned Version 1.\
Every time the Transformer is edited and then published again, the version number is incremented:\
Example: Version 2, Version 3, and so on.

**Note 1:** For default Transformers, the version is always set to “1” because these are populated from the template.\
**Note 2:** Until the Transformer is published, the status displays **Pending Publish**. Once the Transformer is published in the staging or production environment, the status updates accordingly on the Transformer screen.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FeaRpFiCZnBHy7CX2poxa%2FVersioning.mp4?alt=media&token=43ae7340-ecc5-4293-a4db-d3afb59a4a89>" %}


# Publish

The **Publish** option provides an overview of all the tags that are present on the Ingest Labs application. Any tag that is created in Ingest Labs includes the following stages:

* **Pending Publish**: A newly created tag appears with a "Pending Publish" status in orange color.
* **Staging**: Before any tag can be published to "Production" it has to be first published to "Staging". Once published to staging, it displays as **staging** in green.
* **Production**: In the Publish Project to Production screen, review the tags, providers, triggers, and transformers that are ready for production. You can now publish the tag to "Production". Once you publish the tag in production, it displays **production** in green.

The stages are displayed on the Tags UI screen:

<figure><img src="/files/ohytznSHW9m235fqUAiE" alt=""><figcaption></figcaption></figure>

**Note**: A disabled tag is displayed in grey background.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Publish section includes the following topics:

* [Publish Screen](/tag-manager/publish)
* [Publish the Tag to Staging](/tag-manager/publish/publish-to-the-staging)
* [Publish the Tag to Production](/tag-manager/publish/publish-to-the-production)


# Publish Screen

## Introduction

This document describes the Publish screen UI elements.

<figure><img src="/files/D7ikBKFSEzc7HJewQSF0" alt=""><figcaption></figcaption></figure>

The **Publish Timeline** screen is categorized into two environments:&#x20;

* Staging
* Production

<figure><img src="/files/ZaIEGsqvarlSyPbsZGjf" alt=""><figcaption></figcaption></figure>

**Staging**

The **Staging** section displays all the publish info.

<figure><img src="/files/ZVPif3UjNbz1NHvckr4d" alt=""><figcaption></figcaption></figure>

When an element is published, it remains in the ***Pending Publish*** state and is listed in the *Publish to Staging* section.

**Note:** This can be any element.

<figure><img src="/files/uhF7nfo3mOqUrpbsxcgy" alt=""><figcaption></figcaption></figure>

Click **Publish to Staging.**

<figure><img src="/files/Y9mTzyCIxBq7wbQX8GC7" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/nX38deNLc54X4W9htVyk" alt=""><figcaption></figcaption></figure>

Select the required element and click **Review**.

<figure><img src="/files/3vmreGxUHlQSrwA7Xdv2" alt=""><figcaption></figcaption></figure>

* In the **Name** field, enter the element name.
* In the **Description** field, enter the description.

<figure><img src="/files/TbGL4n3u8KaulaDxVMDU" alt=""><figcaption></figcaption></figure>

Click **Publish to Staging.**

<figure><img src="/files/mvou3tyJ05pUrttia4X2" alt=""><figcaption></figcaption></figure>

**Result:** The element is in the *Staging* state.

**Production**

The ***Production*** section displays the elements that are pushed from the ***Staging*** section. Then, you can publish the elements to *Production,* so they go live.&#x20;

<figure><img src="/files/D1Pxx9E6v6nIor0eSTjK" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/YnjJwTCnZpbe6u5JSBie" alt=""><figcaption></figcaption></figure>

**Note:&#x20;*****Pending to Publish*** change is visible on the dashboard in about 4-5 mins for client-side tags after the CDN cache for client SDK is cleared. For server-side tags, it is almost immediate.

## Adjust Publish View Per Page

This option indicates the number of Publish items currently displayed out of the total available Publish items.\
You can adjust the number of Publish items displayed per page using the dropdown menu located at the top-right corner of the screen.

* **50 per page:** Displays up to 50 Publish items on the current page.
* **100 per page:** Displays up to 100 Publish items on the current page.
* **200 per page:** Displays up to 200 Publish items on the current page.

<figure><img src="/files/y64t6zsULoh6uqPpBuyf" alt=""><figcaption></figcaption></figure>

Click the **Refresh.**

A **Fetching Data Elements…** message appears while the system retrieves and displays the updated data.

<figure><img src="/files/i1pKKlEpcM4Knpd15dUD" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F2NJcjjXAkTVjrfQKVJBE%2FPublish%20screen.mp4?alt=media&token=4bb556ad-fb76-4c1a-9471-06117e5fd436>" %}

[<br>](https://ingest-lab.netlify.app/tagmanager/publish/)


# Publish to the Staging

## Introduction

After creating any elements, you must first publish to the Staging Environment and then in the Production environment.

## Procedure

To publish the tag to Staging, perform the following steps:

**Step 1:** Select **Publish** from the left navigation panel.

<figure><img src="/files/lw6r3tT6iHdIBFVeYdHe" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the staging tab.

<figure><img src="/files/nJfntZ8aqVqFnJyCqSZF" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Publish to Staging**.

<figure><img src="/files/Rka064hitTfobDOfe7gd" alt=""><figcaption></figcaption></figure>

**Step Result**: The *Publish to Staging* screen appears. Any newly created elements remain in a pending publish status, and you can view them here on this screen.

<figure><img src="/files/6zAufnZmLL0tnWbWUF6d" alt=""><figcaption></figcaption></figure>

**Step 4:** Select the element and click **Review** on the top-right corner of the screen.

<figure><img src="/files/kwaU4NqUzzvyQ9WDi3zA" alt=""><figcaption></figcaption></figure>

**Step 5:** Enter the Publishing Name in the **Name** field and provide **Description.**

<figure><img src="/files/TOh3kviOnDWCWcQMou8R" alt=""><figcaption></figcaption></figure>

**Step 6:** Review the tags that are selected and click **Publish to Staging**.

<figure><img src="/files/tfxykeKiWrFSp2RhmjN7" alt=""><figcaption></figcaption></figure>

**Step 7:** Click the refresh icon on the top right to change the status from Publish to Staging->Queued->Finished->Published.

![](https://ingest-lab.netlify.app/images/publishimages/refreshstatus.png)

**Step Result**: The Published tag appears with the Published status.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FbbXqEEIXqlgk4m7Zrw0z%2FPublish%20the%20Tag%20to%20Staging.mp4?alt=media&token=92f38ad5-095d-4df9-88bb-bb3dc6595fda>" %}


# Publish to the Production

## Information

Before publishing a tag in the Production environment, the tag must be published in the Staging environment.

## Production

To publish a tag from the Staging to the Production environment, perform the following steps:

**Step 1:** Select **Publish** from the left navigation panel.

<figure><img src="/files/eBcN2sfw6vhFPXHB6dsz" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Production** tab to view all the tags in the Production environment.

<figure><img src="/files/RYIPazXa5huADtA4papb" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Publish to Production**.

<figure><img src="/files/6d1bes6uTQa1zW4kwhEz" alt=""><figcaption></figcaption></figure>

**Step Result**: The list of Tags, Providers, Transformers, and Triggers appears on the screen.

<figure><img src="/files/xudLuoaZfdhQP1LBM27b" alt=""><figcaption></figcaption></figure>

**Step 4:** Select the list items that are to be published to production and click **Review**.

<figure><img src="/files/bFnKfAWvcd9KERgq4Q4d" alt=""><figcaption></figcaption></figure>

**Step 5:** In the *Name* field, enter the name, and in the *Description* field, enter the description.

<figure><img src="/files/i2IpArNKmt0T96REHtTW" alt=""><figcaption></figcaption></figure>

**Step 6:** Click **Publish to Production** on the top-right of the screen.

<figure><img src="/files/D4XfTcfRBUbqpsf87zmu" alt=""><figcaption></figcaption></figure>

**Step 7:** Click the refresh icon on the top right to change the status from Publish to Staging->Queued->Finished->Published.

<figure><img src="/files/6sEmqApUJVbSNQxc8JBw" alt=""><figcaption></figcaption></figure>

**Step Result**: The relevant tags are published to Production. The tag will be successfully moved from the Staging environment to the Production environment.

<figure><img src="/files/Z0Z1EOmRJwRFoTCz5IMA" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FGFzLtTsWo1wWnhOAAwKs%2FProduction%20Final%20video.mp4?alt=media&token=ea224a5a-824b-4461-a79f-a485f40f1db7>" %}


# Live Debugging

## Introduction

The Live Debugging feature in Ingest Labs displays all the tags that are triggered in real-time on a particular page. You can perform live debugging for both the server-side tags and browser-side tags. The event data is populated in the live debugging section.

## **Procedure**

There are two environments present:

* **Production** – When elements are pushed to the production environment, you can check the live details in the production environment.&#x20;
* **Staging** – When elements are pushed to the staging environment, you can check the live details in the staging environment.

<figure><img src="/files/9mOTpcgHLMVkCtSnrd9y" alt=""><figcaption></figcaption></figure>

**Step 1:** Select **Production** from the drop-down.

**Note**: When elements are pushed to the staging environment, you can check the live details in the staging environment.

<figure><img src="/files/bT9nttmqxLYJu9UaDoYn" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Start Debugging** button.

<figure><img src="/files/kNflGKFZUgfk9Mau2EX6" alt=""><figcaption></figcaption></figure>

**Step 3:** The **Start Live Debugging** popup window opens. Without entering a Debug ID, click **Start**.

<figure><img src="/files/zDUapBMiKEnLyDK1qnaE" alt=""><figcaption></figcaption></figure>

**Step 4:** The ***Live mode*** option is displayed with a red dot indicator. You can view all the events firing in real-time traffic on the website.

<figure><img src="/files/JD0GBrIGQPnPvjJMgIh2" alt=""><figcaption></figcaption></figure>

**Step 4.1**: To stop debugging, click the ***Live mode*** drop-down and select **Stop Debugging.**

<figure><img src="/files/ubkEVH8ekDoyg2kerIKJ" alt=""><figcaption></figcaption></figure>

**Step 4.2:** To clear the debugging session, click the ***Live mode*** drop-down and select **Clear**.

<figure><img src="/files/PAZ34SkmIa79iz41m0Bt" alt=""><figcaption></figcaption></figure>

**Step 5:** Click on **View request** of any SS tag to view API call request/response body.

![](https://ingest-lab.netlify.app/images/livedebuggingimages/viewrequest.png)

**Step 5.1:** The ***Tag Request Details*** popup window opens. You can view the following tag details:

* **Tag URL** – displays the tag URL.
* **Tag URL Query Parameters Assignment** – displays the query parameters associated with the tag.

<figure><img src="/files/Ts2UkeOhYURkDVLxRyp6" alt=""><figcaption></figcaption></figure>

**Step 5.2:** Click **Data Elements** to view the data element details.

<figure><img src="/files/6EqsvN1qL8NUb6UEuMgH" alt=""><figcaption></figcaption></figure>

**Step 5.3:** Click **Request Body** to view the details of the request body.

![](https://ingest-lab.netlify.app/images/livedebuggingimages/requestbody.png)

**Step 5.4:** Click **Response Body** to view the details of the response body.

![](https://ingest-lab.netlify.app/images/livedebuggingimages/responsebody.png)

The following are the additional fields that appear on the *Live Debugging* screen.

| Field Name     | Description                                                                           |
| -------------- | ------------------------------------------------------------------------------------- |
| **Event Time** | Displays the event time-stamp.                                                        |
| **Page Name**  | The page from which the tag is triggered.                                             |
| **Provider**   | Displays the Provider details.                                                        |
| **Tag**        | Displays the Tag details.                                                             |
| **Platform**   | Displays the Platform from which the page is accessed.                                |
| **Domain**     | Shows the domain from which the tag is triggered.                                     |
| **Status**     | Displays the tag status, indicating whether the tag is successfully triggered or not. |

**Note 1:** You can perform the Live Debugging in two ways, either through the console or through a Live Debugging session on Ingest Labs.

**Note 2:** Use the pagination control at the bottom of the page to navigate through multiple pages. The current page is highlighted in blue.

<figure><img src="/files/z18ykFY8kXMpRXLPkziU" alt=""><figcaption></figcaption></figure>

**Step 6**: Click **Add Filter**. The *Add Filter* panel opens on the right side

<figure><img src="/files/5rSdfIaaMgIChEKaveDh" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rroAtMYqtHjMoN3ZWvtr" alt=""><figcaption></figcaption></figure>

**Step 6.1:** Under **Field,** click ***Select Field*** drop-down and choose the required field.

<figure><img src="/files/iIRwOFWxbgvT5MltHX3z" alt=""><figcaption></figcaption></figure>

**Step 6.2:** Under **Operator**, click the *Select an Operator* drop-down. You will see two options:

* is one of
* is not one of

<figure><img src="/files/T0lyKfPoSKGxYnfw4r7X" alt=""><figcaption></figcaption></figure>

**Step 6.3:** After selecting an operator, a list opens. Select one or multiple values as needed.

<figure><img src="/files/A9zuqVPY1TkHVkaOIHPy" alt=""><figcaption></figcaption></figure>

**Step 6.4:** Click **Add Filter** to apply the filter.

<figure><img src="/files/TiA5uAusMsrZEwmTyMLo" alt=""><figcaption></figcaption></figure>

**Note:** Click **Cancel** to close the panel without saving any changes.

<figure><img src="/files/h2Vzo6TMuhEbatL6JFII" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F6hVWUozkQ62ZLbckvN3w%2FLive%20Debugging.mp4?alt=media&token=c6f103d2-ee8f-4857-9d45-2720780ee1b3>" %}

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Live Debugging section includes the following topics:

* [Retrieve the Debug ID Using Console](/tag-manager/live-debugging/retrieve-the-debug-id-using-console)
* [Use IngestLabs Debugging session](/tag-manager/live-debugging/view-requests-from-a-live-debugging-session)
* [Filter the Events During Live Debugging](/tag-manager/live-debugging/filter-the-events-during-live-debugging)


# Retrieve the Debug ID Using Console

## Introduction

You can perform live debugging using the Debug ID on the console.

## Procedure

**Step 1:** Navigate to the particular brand website.

**Step 2:** Right-click on the webpage, select **Inspect**, and then click the **Console** tab.

<figure><img src="/files/zHkXcZIPrIRauCuYurv8" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/2LzeKjRCx1QoyhtrpzgP" alt=""><figcaption></figcaption></figure>

**Step 3:** Enter the following command: **\_mp.printDebugId()**

<figure><img src="/files/3OSdlK3DBZBgMBUdnTYk" alt=""><figcaption></figcaption></figure>

**Step Result**: The Debug ID appears on the screen.

<figure><img src="/files/XvYIpSVy27HrOfESmPjv" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FYYnCNW3rRxvbiaT7irIc%2FRetrieve%20the%20Debug%20ID%20Using%20Console.mp4?alt=media&token=e3719937-4f65-49bd-8c89-5c5365d8970f>" %}


# View Requests From a Live Debugging Session

## Introduction

Live Debugging is performed either in Staging environment or in the Production environment.

## Procedure

To perform Live Debugging on Ingest Labs:

**Step 1:** Select **Live Debugging** on the left navigation panel.

<figure><img src="/files/ZoUOM3DzQB5JSBFAgbP6" alt=""><figcaption></figcaption></figure>

**Step 2:** There are two environments present:

* **Production** – When elements are pushed to the production environment, you can check the live details in the production environment.&#x20;
* **Staging** – When elements are pushed to the staging environment, you can check the live details in the staging environment.

<figure><img src="/files/t8ji7y1PkyrQ72qdlGvu" alt=""><figcaption></figcaption></figure>

For this demonstration we have taken example of Production, click Production.

<figure><img src="/files/vvrJ6F5z2rlwC98q49zO" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Start Debugging** on the top right corner of the screen.

<figure><img src="/files/YFXjK29OGFYgMpMbqjp9" alt=""><figcaption></figcaption></figure>

**Step 4:** Enter the Debug ID in the **Debug ID** field or click **Start** to start the debugging session. You need to enter a Debug ID to see events exclusively from your session on the website.

<figure><img src="/files/FygkgQkFZx27aRNTjCnt" alt=""><figcaption></figcaption></figure>

The following screen appears:

**Step Result**: The live debugging details appear on the screen. Now, you can view all the events firing in real time, only for your session on the website, for debugging purposes.

<figure><img src="/files/pDls4S1gYThpXd1ymcHQ" alt=""><figcaption></figcaption></figure>

**Note 1**: The Debug ID is unique and is meant to streamline traffic tracking. Without a debug ID, you will be bombarded with general traffic data. Using a debug ID will help to streamline data and view the traffic for a particular session. A debug ID is not mandatory for Staging. A Debug ID is required for Production due to the huge network traffic.

**Note 2:** To retrieve the Debug ID, follow the procedure **Retrieve the DebugID Using Console**.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2F3IIKCJrXWuyzoMl01Iyy%2FUsing%20Debugging%20Session.mp4?alt=media&token=e0d59b52-2222-4542-9ff8-6ecdd0b8e6dc>" %}


# Filter the Events During Live Debugging

## Introduction

As all the debugging data of the triggered tags are populated in the live debugging page, you can apply filters to view only the events based on a particular field or type or parameter.

## Procedure

To filter the events during Live Debugging, perform the following steps:

**Step 1**:  Click **Add Filter**.

<figure><img src="/files/xZ0ZQ4j9cU4IvGvMNrX9" alt=""><figcaption></figcaption></figure>

The Add Filter panel opens on the right side.

<figure><img src="/files/Fs1Qplar9weL8ZiADlEG" alt=""><figcaption></figcaption></figure>

**Step 2**: Click the **Select a Field** drop-down and select the appropriate field.

<figure><img src="/files/xGj3BprHDtIY8ho1P6G2" alt=""><figcaption></figcaption></figure>

**Step 3:** Click the **Select an Operator** drop-down and choose the appropriate operator.

You will see two options:

* *Is one of* – use this when you want to include only the selected values.
* *Is not one of* – use this when you want to exclude the selected values.

<figure><img src="/files/DpNpuUWcOrqDow5xSqJ1" alt=""><figcaption></figcaption></figure>

After selecting the operator, a list opens. Select one or multiple values from the list as per your requirement.

<figure><img src="/files/MknmsHuT7nRf60qd5qGE" alt=""><figcaption></figcaption></figure>

**Step 4:** Click **Add Filter** to apply the filter.

<figure><img src="/files/h1zgJlUz1TdaVap5rqv3" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FefBqBlDyMaErsr1B7n8h%2FFilter%20the%20Events%20During%20Live%20Debugging.mp4?alt=media&token=f36e4781-4f06-4a26-a436-e78a3a9b3dab>" %}


# Data Governance

Data Governance ensures companies follow legal regulations when triggering tags in Tag Manager. Data Governance serves as a controller or approver for these guidelines, which may include government policies like CCPA and GDPR. For example, when a website detects a visitor from a state with privacy laws, it displays a consent banner. This banner informs the user that their information will be tracked after obtaining their consent for further data tracking purposes.

The banner providers are called Consent Managers, with One Trust being a prominent example. Ingest Labs utilizes the consent obtained from these banners to determine whether to trigger media tags. The Privacy Compliance Data element, **pr\_comp**, returns **True** or **False** when Ingest Labs executes the provided JavaScript in the Custom JavaScript section. With Ingest Labs, you can seamlessly integrate with any Consent Manager available, as long as it can read consent from the website browser using JavaScript.

The default pr\_comp value is set to true. This means that a user’s activities are tracked by default.

Even if a user denies data tracking consent, Ingest Labs has some providers in the ‘allowed’ state, that will still always be allowed. The other providers, however, in the ‘blocked’ state are blocked when a user denies consent.

A client can choose to block or allow providers at any time. Ingest Labs marks such changed providers as 'modified' until the client publishes them manually. After publishing, the provider is successfully modified.

**Note:** The Data element **pr\_comp** returns **True** if the user accepts data tracking.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Data Governance section includes the following topics:

* [Data Governance Screen](broken://pages/JFLPMTdlXxcrYbdQ1Vrm)
* [Edit Data Governance Status](/tag-manager/data-governance/editing-the-status-of-a-provider-in-data-governance)
* [View Data Governance Timeline](/tag-manager/data-governance/view-data-governance-timeline)


# Editing the Status of a Provider in Data Governance

## Introduction

This section explains how to edit the status of a provider under the **Data Governance** module.

## Procedure

To edit the status of the provider under Data Governance, perform the following steps:

**Step 1:** From the left navigation panel, click the **Data Governance** drop-down, and then click **Provider.**

<figure><img src="/files/QSF5jdzR3il6eTRP0r0H" alt=""><figcaption></figcaption></figure>

**Step 2:** Click **Edit** to modify the provider’s details.

<figure><img src="/files/SwTZ0pOGsULWUhscsWK1" alt=""><figcaption></figcaption></figure>

**Step 3:** From the Status column, open the **Allowed** drop-down menu and select **Blocked** to stop data tracking. You can also change the status back to **Allowed** if you want to enable data tracking again.

<figure><img src="/files/qHHH5JuyXDPS293bFjnq" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/qRihOY7hbkIEzD264ps8" alt=""><figcaption></figcaption></figure>

**Step 4:** Click **Review** to review the changes before you submit the changes.

![](https://ingest-lab.netlify.app/images/datagovernanceimages/providerslist.png)

**Step 5:** Enter the name in the **Name** field and a description in the **Description** field, then click **Save**. Click **Submit** to submit the changes.

<figure><img src="/files/zDWA5Zw18XLwzywEG6c8" alt=""><figcaption></figcaption></figure>

**Step 6:** A confirmation message will appear indicating that the provider’s data has been updated successfully.

<figure><img src="/files/Ed70UGaDIfBXUQdM2EJW" alt=""><figcaption></figcaption></figure>

**Step Result:** The Provider status is updated in the Data Governance screen as well as in the [Providers](https://ingest-lab.netlify.app/tagmanager/providers/) section.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FvQEvje9ITAV7E9ZIbD7x%2FEditing%20the%20Status%20of%20a%20Provider%20in%20Data%20Governance.mp4?alt=media&token=69f7669b-98a4-44ee-954b-12b0954fd631>" %}

[<br>](https://ingest-lab.netlify.app/tagmanager/datagovernance/datagovernancescreen/)


# View Data Governance Timeline

Once the Provider status is updated, you can view all the client-side changes. The Data Governance Timeline screen lists all the providers updated from Allowed to Blocked or Blocked to Allowed.

![](https://ingest-lab.netlify.app/images/datagovernanceimages/datagovernancetimeline.png)

**Note:** Whenever a provider status is modified from **Allowed** to **Blocked** or **Blocked** to **Allowed** under Data Governance, the Provider section is also modified with the changes.

You must also ensure to navigate to the Publish section and publish the provider status of the respective provider.

Click the **show changes** to view the timeline changes:

![](https://ingest-lab.netlify.app/images/datagovernanceimages/changes.png)

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FYKp3kp5ceWjdLdD86o9Q%2FView%20Data%20Governance%20Timeline%201.mp4?alt=media&token=5a456453-7481-4785-9b46-96ca96f924b1>" %}

[<br>](https://ingest-lab.netlify.app/tagmanager/datagovernance/editdatagovernancestatus/)


# New Consent Classification

### Introduction

Cookie consent is the process of asking website visitors for permission to store and use their data through cookies.

### Steps to Manage Cookie Consent

Navigate to **Tag Manager** > **Data Governance** > **Cookie Consent Providers**.

**Follow these instructions to successfully set up a new provider:**

**Step 1**: Click **Add Cookie Provider**.

<figure><img src="/files/398y9moyOoqx4AguDcWx" alt=""><figcaption></figcaption></figure>

**Step 2:** Enter Provider Details.

**Name:** Input an appropriate and descriptive name for the Cookie Consent Provider.

**Description:** Provide a clear and relevant description that outlines the purpose of the provider.

<figure><img src="/files/Rqo4CLnWc5j5coyY8PE5" alt=""><figcaption></figcaption></figure>

**Step 3:** Select Consent Template.

Choose between the two available consent templates:

**One Trust Consent Provider**: This is a third-party solution for managing cookie consent. It's an external service that integrates into your system to handle user consent preferences automatically.

**Custom Template**: This allows you to design and configure your own cookie consent setup according to your specific requirements.

<figure><img src="/files/AS77bOX4MYJoOfVrBEz5" alt=""><figcaption></figcaption></figure>

**Step 3.1: One Trust Consent Provider**:

Follow these steps to set up a Cookie Consent Provider with the One Trust Consent Provider template:

When you choose the **One Trust Consent Provider** template, you won’t need to write JavaScript code, as it's a third-party solution that automatically manages cookie consent for you.

**Name**: Click the **Name** field and enter a unique and descriptive name for the provider.

**Description**: Click the **Description** field and provide a brief explanation of what the provider does.

After filling in the necessary details, click **Save** to finalize the setup.

<figure><img src="/files/SKDenLlrUch8fY69t1kl" alt=""><figcaption></figcaption></figure>

**Step 3.2**: Follow these steps to set up a Cookie Consent Provider with the Custom Template:

**Name**: Click the **Name** field and provide a unique name for the provider.

**Description**: Click the **Description** field and enter a brief explanation of the provider's purpose.

**JavaScript**: In the **JavaScript** field, paste the relevant custom JavaScript code that handles the cookie consent functionality.

After filling in the necessary details, click **Save** to finalize the setup.

<figure><img src="/files/0RCs19n0I8PEir4tssY4" alt=""><figcaption></figcaption></figure>

**Assigning Classification Codes**

Cookie classifications help you organize and manage cookies based on their purpose and functionality.

Assigning appropriate classifications ensures compliance with regulations and provides clarity for users about how their data is being used.

Common Cookie Consent Classification Codes:

· **Strictly Necessary Cookies**: Cookies that are essential for the website to function:  C0001

· **Preference Cookies:** Cookies that remember user preferences or choices: C0002

· **Performance Cookies**: Cookies that collect information about website usage:  C0003

· **Targeting/Advertising Cookies**: Cookies used to deliver personalized ads, track browsing behaviour, and build user profiles for targeted advertising: C0004

· **Functional Cookies**: Cookies that provide additional functionality, such as remembering login credentials or enabling live chat: C0006

·**Session Cookies**: Temporary cookies used for maintaining a session across pages: C0007

· **Persistent Cookies**: Cookies that stay on the user's device after the session ends, typically used for remembering login details or user preferences between sessions: C0008

· **First-party Cookies**: Cookies set by the website the user is currently visiting: C0009

· **Third-party Cookies**: Cookies set by external sites, usually for advertising, tracking: C0010

**Ste 1:** On the left-hand menu under **Data Governance**, click **Cookie Classifications** to access the classification settings.

<figure><img src="/files/ghwE9ZAhhWYzJO15OQ9s" alt=""><figcaption></figcaption></figure>

**Step 2:** Click the **Add Cookie Classification** button located at the top right.

<figure><img src="/files/qhsjX2AREpwuIuz7uCfo" alt=""><figcaption></figcaption></figure>

**Step 3: Classification Code**: Add an appropriate code to identify the classification.

**Step 4: Classification Name**: Add a descriptive name for the classification.

**Step 5: Description**: Provide a brief explanation outlining the purpose of the classification.

<figure><img src="/files/xJPa502XxmigUre2QaNs" alt=""><figcaption></figcaption></figure>

**Step 6:** Under Cookie Providers, click Add Provider to add the appropriate provider.

<figure><img src="/files/LOzFufy3OSPIqnXkvVRI" alt=""><figcaption></figcaption></figure>

**Step 7:** In the Consent Code, give the appropriate consent code. Click Provider and select the appropriate cookie provider.

List of consent codes are:

· **Consent Given:** The user has consented to the use of strictly necessary cookie: C0001-allow

· **Consent Denied:** The user has denied consent for strictly necessary cookies: C0001-deny

· **Full Consent:** The user has granted consent for all cookie categories: C0000-all-allow

· **Partial Consent:** The user has given consent for some cookie categories (e.g., accepting necessary and performance cookies, but rejecting advertising cookies) C0000-partial-allow

· **No Consent Given:** The user has not given consent for any cookies, meaning no cookies (except strictly necessary) should be set: C0000-no-consent

<figure><img src="/files/VT4dxsMsloo1GIViUXK9" alt=""><figcaption></figcaption></figure>

**Step 8:** Once all details are entered, click **Save**

A confirmation message will appear: ***Cookie Classification was created successfully**.*

<figure><img src="/files/SRWciudGmi0BU6wwJ36p" alt=""><figcaption></figcaption></figure>

**Step 9:** The status will be marked as **Pending Publish**. To finalize, you must publish the classification.

<figure><img src="/files/0TOzueQ4tNY6Lig95qHV" alt=""><figcaption></figcaption></figure>

**Publish the Cookie Classification**

**Step 1:** On the left-hand menu click **Publish**.

<figure><img src="/files/pkqJT8YTifGqnnvabKZC" alt=""><figcaption></figcaption></figure>

**Step 2:** Click Publish to Staging.

<figure><img src="/files/IfK56nMagP6ZqN1KlFt5" alt=""><figcaption></figcaption></figure>

**Step 3:** Scroll down to the **Classification Codes** section and check the appropriate cookie classification. Once selected, the related **Cookie Provider** will appear automatically.

<figure><img src="/files/TEBv11bZnJg2vD6qrZH9" alt=""><figcaption></figcaption></figure>

**Ste 4**: Scroll up and click **Review**.

<figure><img src="/files/7pfi7Jqln3e1JcghetnK" alt=""><figcaption></figcaption></figure>

**Step 5**: In the **Name** section, provide an appropriate name. In the **Description** section, enter a relevant description, and then click **Publish to Staging**.

<figure><img src="/files/SSHe79FA2BKiJGqlMIdL" alt=""><figcaption></figcaption></figure>

**Step 6:** A popup message will appear, confirming the publication with the message: ***Published item successfully**.* This confirms that the item has been published.

<figure><img src="/files/RcZoBoIo7Go7lXR36iNU" alt=""><figcaption></figcaption></figure>

### Steps to Add a Provider

**Step 1:** In the left-hand menu, go to the **Providers** section.

<figure><img src="/files/ndaLeMeYWJD5Y7WyBlmK" alt=""><figcaption></figcaption></figure>

**Step2:** Click the particular **Cookie Classification**, then click the **Action** button dropdown and select **Edit**.

<figure><img src="/files/iReQRPZqERSLwHKx8t7u" alt=""><figcaption></figcaption></figure>

**Step 3:** Scroll down to the **Classification Codes (Optional)** section and click **Add Classification Codes**.

<figure><img src="/files/q6v1nANfbkAFjFY12A5D" alt=""><figcaption></figcaption></figure>

**Step 4:** The **Classification Codes** panel will open on the right side. You can either search for a code in the search bar or create a new one by clicking **Create Consent Classification**.

<figure><img src="/files/2H8yAGP3cRYfvkHXjGwN" alt=""><figcaption></figcaption></figure>

**Step 5:** Click **Save**

A popup message will appear: ***Provider was updated successfully**,* confirming the update.

**Restoring a Deleted Cookie Consent Provider**

**Note 1:** Both Cookie Consent Providers and Cookie Classifications have a restore option, allowing you to recover deleted items if needed.

**Note 2:** The restore option for both Cookie Consent Providers and Cookie Classifications is available only if they have been published.

**Note 3:** To delete a Cookie Classification, it must not have any dependencies. If dependencies exist, they must be removed before the classification can be deleted.

<figure><img src="/files/04T8jZFnIroSDSvEslFN" alt=""><figcaption></figcaption></figure>

Click **Restore**.

<figure><img src="/files/0EWT9aTpB6lKdII1IdMd" alt=""><figcaption></figcaption></figure>

A confirmation pop-up message will appear, confirming that the Cookie Classification has been restored successfully.

<figure><img src="/files/WNHrV4vKZzQZyTHFH6Tw" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2Fo0J73mDiDKylvMw56IkH%2FNew%20Consent%20Classification%202.mp4?alt=media&token=77c86629-0e59-41e0-bd2e-e38a770fba57>" %}


# Steps to Add a Consent Provider

## Introduction

A **Consent Provider** collects, stores, and manages users’ permission for data collection and use.

## Procedure

**Step 1:** Under the Data Governance drop-down, click **Consent Providers.**

<figure><img src="/files/Nm8UrollRhbYZcXFNJ0b" alt=""><figcaption></figcaption></figure>

**Step 2:** Click on **Add Consent Provider**.

<figure><img src="/files/y7CFulwJJSYxpbVGX20J" alt=""><figcaption></figcaption></figure>

**Step 3:** The **Consent Provider** panel opens from the right side. In the **Name** field, enter the appropriate name. In the **Description** field, provide a proper description.

<figure><img src="/files/E81XjBckZUd5FrJVVeuh" alt=""><figcaption></figcaption></figure>

**Step 4:** Click **Consent Template**. The **Select Consent Template** panel opens. Choose a template from the drop-down list or use the search bar to find and select the required template.

<figure><img src="/files/ZBuaw2rveD4BHzdv57E4" alt=""><figcaption></figcaption></figure>

**Step 5:** The selected Consent Template is displayed under the **Consent Template** field. Click **Save**.

<figure><img src="/files/1timuPalD2hg9pM5qQUk" alt=""><figcaption></figcaption></figure>

**Step 6:** The created Consent Provider is displayed on the screen with the following details:

* **Name** – The name of the Consent Provider.
* **Template** – The Consent Template associated with the provider.
* **Status** – Indicates the current state of the provider.
* **Updated By** – The user who last updated the provider.
* **Updated On** – The date and time of the last update.

<figure><img src="/files/sJcOArnhOrvolyPDLrN8" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FxFnREkHNACTr0J70Bqc3%2FSteps%20to%20Add%20a%20Consent%20Provider.mp4?alt=media&token=1beecbb5-694f-4a3a-9f2e-0bf340cfd958>" %}


# Environments

Ingest Labs includes two environment types to clearly segregate the stages of implementation:

* Staging
* Production

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Environments section includes the following topics:

* [Environments Screen](/tag-manager/environments/environments-screen)
* [View Staging Environment](/tag-manager/environments/view-staging-environment)
* [View Production Environment](/tag-manager/environments/view-production-environment)


# Environments Screen

## Introduction

This document describes the Environment screen UI elements.

## Procedure

**Step 1:** From the left navigation panel, click *Environment.*

<figure><img src="/files/vnZDyk2OzhrbZTqM5dFg" alt=""><figcaption></figcaption></figure>

**Step 2:** Overview of Environment Screen Options.

<figure><img src="/files/5e6EkbuA9JLUZP73Nstk" alt=""><figcaption></figcaption></figure>

| Field Name      | Description                                                                    |
| --------------- | ------------------------------------------------------------------------------ |
| Name            | The *Name* field shows which Environment it is, such as Staging or Production. |
| Status          | Denotes the Environment status.                                                |
| Author          | Denotes the user who created the environment.                                  |
| Last Updated on | Denotes when the Environment is last updated.                                  |

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FwWYshfNOc1VK5kUNlEX3%2FEnvironment%20screen.mp4?alt=media&token=a0a65cff-56b2-4e78-aaa3-c700dc7248e9>" %}


# View Production Environment

## Introduction

To view the Production Environment, select the **Production** option on the Environments screen.

## Procedure

Under the *Name* field, click *Production*.

<figure><img src="/files/71S6oWboUrFtXs3bxxI8" alt=""><figcaption></figcaption></figure>

## Info <a href="#info" id="info"></a>

The **Info** section includes the following information.

* **Name**: Displays **production**, indicating the environment type.
* **Description**: Displays **Production Environment**, which gives more details about the selected environment.

<figure><img src="/files/WVIeS5g9u7O6bV3W4j6j" alt=""><figcaption></figcaption></figure>

## SDK Settings <a href="#sdksettings" id="sdksettings"></a>

<figure><img src="/files/UNezJRyvs4GFamb0VRHS" alt=""><figcaption></figcaption></figure>

Click ***Edit***.

<figure><img src="/files/csuQeLR3yYaZAd9bG9dB" alt=""><figcaption></figcaption></figure>

The SDK Settings section includes the following information:

#### Event Type

Denotes the specific event that will be used to trigger the tag.

<figure><img src="/files/a35rmCYFk6LuvuE5sE9X" alt=""><figcaption></figcaption></figure>

#### Event Trigger

Specifies the condition that activates the tag. You can choose from the following options:

* **On Page Interactive** – Triggers the tag when the page becomes interactive (for example, when the DOM is fully parsed and ready for user interaction).
* **On Page Loaded** – Triggers the tag as soon as the page is loaded.
* **Custom Page Event** – Allows you to define a custom event that triggers the tag.

<figure><img src="/files/TqIYJm0v8Yo3nFMQygSg" alt=""><figcaption></figcaption></figure>

#### Secondary Trigger (JavaScript Variable)

Select this checkbox to enable a secondary trigger.&#x20;

Once enabled, two additional fields appear:

* **Variable Name** – Specify the JavaScript variable that acts as the secondary trigger.&#x20;
* **Wait Time** – Enter the in milliseconds that the system should wait before triggering the secondary action.

<figure><img src="/files/U15NZYbjq3AxHIiXvO9V" alt=""><figcaption></figcaption></figure>

#### Cookie Domain

Determines how the cookie domain is set. Two options are available:

* **Auto** – The cookie domain is automatically detected at runtime.
* **Manual** – Allows you to manually specify the cookie domain.

**Note:** The cookie domain is automatically detected at runtime, so you don’t need to configure it manually.

<figure><img src="/files/fq1uQsUUSDO9RFL9ghbd" alt=""><figcaption></figcaption></figure>

#### **Enable Error Logging**

Provides options to capture and report SDK errors on the client side.

* **Report Client-side SDK Errors** – Select this checkbox to allow the Client SDK to report errors and exceptions to the Ingest Labs servers.
* **Enable Logging for Client-side SDK** – Select this checkbox to capture and log client-side SDK activities locally for troubleshooting.

<figure><img src="/files/wPCpKemSTawIfzGolW95" alt=""><figcaption></figcaption></figure>

#### Trigger Delay

With Trigger Delay, you can set how long, in milliseconds, the system should wait after the page loads before firing the tag.

Note: Allows the page to render its content before the Tag Manager is fired, ensuring that all necessary elements are available.

<figure><img src="/files/6cdze9MXRTfD9MkpFgex" alt=""><figcaption></figcaption></figure>

#### Content Security Policy

This allows the client to add an additional CSP field so we can use the same csp field to add scripts to the website - Else, it will fail. Select this check box to enable or disable this option. If Enabled, the following option is available.

* Meta tag attribute name for Nonce: The Attribute name in meta tag where the Nonce value is configured in the website.

<figure><img src="/files/a3vLpyCuCsuiTSCVoIWG" alt=""><figcaption></figcaption></figure>

### SDK Setup <a href="#sdksetup" id="sdksetup"></a>

To set up Ingest Labs SDK, you must include the following script tag in index.html file of the website. Once the script is executed, the SDK is installed on the client website.

![sdksetup](https://ingest-lab.netlify.app/images/environmentsimages/sdksetup.png)

The following is the SDK URL that you must embed in the Production environment of the client website. In the IDL Setup, the idl.js file is Identity Link or First party identity script file. The following is the IDL setup url that you must embed in the Production environment of the client website:

![viewproductionenvironment](https://ingest-lab.netlify.app/images/environmentsimages/productioncode.png)

### Approved Domains and Collector URLs <a href="#approveddomainsandcollectorurls" id="approveddomainsandcollectorurls"></a>

The Approved Domains has the list of domains on which the SDK will run. The SDK will execute only these listed domains. This is to avoid spamming and to ensure that the SDK of one site is not used on another site.

The Script sdk url changes when the domain is verified based on the data collector configuration. This decides which collector url to pick based on what domain. Collector url is the url to which Server Side Tags and report calls are sent.

![](https://ingest-lab.netlify.app/images/environmentsimages/datacollectordomain.png)

The Approved Domains & Collector URLs display the following information:

* **Domain** – Enter your website domain in this field.
* **Collector URL** – This displays the URL where the collected data is sent.

**Approved Data Collection Domains** – This section lists the domains that are authorized to collect data.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FrQW1SsCunPtxEjaRV6Zp%2FView%20Production%20Environment.mp4?alt=media&token=a97867d0-5a2b-46bb-9ba2-b6e2ff655065>" %}


# View Staging Environment

## Introduction

To view the Staging Environment, select the **Staging** option on the Environments screen.

## Procedure

Under the *Name* field, click *Staging*.

<figure><img src="/files/Kz6oJnlc2ifq1038OtNm" alt=""><figcaption></figcaption></figure>

## Info <a href="#info" id="info"></a>

The **Info** section includes the following information.

* **Name**: Displays **Staging**, indicating the environment type.
* **Description**: Displays **Staging Environment**, which gives more details about the selected environment.

<figure><img src="/files/5QnIwJJx5AKCCItPV6GS" alt=""><figcaption></figcaption></figure>

### SDK Settings <a href="#sdksettings" id="sdksettings"></a>

<figure><img src="/files/JmqgLXaXmmmPOFdK87DL" alt=""><figcaption></figcaption></figure>

Click ***Edit***.

<figure><img src="/files/ofCBP6ZAFX9f5l5AUK7u" alt=""><figcaption></figcaption></figure>

#### Event Type

Denotes the specific event that will be used to trigger the tag.

<figure><img src="/files/RxY8ciuZ5vqGgeBlLqEq" alt=""><figcaption></figcaption></figure>

#### Event Trigger

Specifies the condition that activates the tag. You can choose from the following options:

* **On Page Interactive** – Triggers the tag when the page becomes interactive (for example, when the DOM is fully parsed and ready for user interaction).
* **On Page Loaded** – Triggers the tag as soon as the page is loaded.
* **Custom Page Event** – Allows you to define a custom event that triggers the tag.

<figure><img src="/files/wI51izNwfOcvI8TGrQfl" alt=""><figcaption></figcaption></figure>

#### Secondary Trigger (JavaScript Variable)

Select this checkbox to enable a secondary trigger.&#x20;

Once enabled, two additional fields appear:

* **Variable Name** – Specify the JavaScript variable that acts as the secondary trigger.&#x20;
* **Wait Time** – Enter the in milliseconds that the system should wait before triggering the secondary action.

<figure><img src="/files/MPachCUpyVrZ0G5glaNx" alt=""><figcaption></figcaption></figure>

#### Cookie Domain

Determines how the cookie domain is set. Two options are available:

* **Auto** – The cookie domain is automatically detected at runtime.
* **Manual** – Allows you to manually specify the cookie domain.

**Note:** The cookie domain is automatically detected at runtime, so you don’t need to configure it manually.

<figure><img src="/files/gfXLqfTH10Qc1k3m8vPK" alt=""><figcaption></figcaption></figure>

#### **Enable Error Logging**

Provides options to capture and report SDK errors on the client side.

* **Report Client-side SDK Errors** – Select this checkbox to allow the Client SDK to report errors and exceptions to the Ingest Labs servers.
* **Enable Logging for Client-side SDK** – Select this checkbox to capture and log client-side SDK activities locally for troubleshooting.

<figure><img src="/files/5lINkBhdfy0Ugxk4zteu" alt=""><figcaption></figcaption></figure>

#### Trigger Delay

With Trigger Delay, you can set how long, in milliseconds, the system should wait after the page loads before firing the tag.

Note: Allows the page to render its content before the Tag Manager is fired, ensuring that all necessary elements are available.

<figure><img src="/files/VkjzLQVx2S413SHS9GqN" alt=""><figcaption></figcaption></figure>

#### Content Security Policy

This allows the client to add an additional CSP field so we can use the same csp field to add scripts to the website - Else, it will fail. Select this check box to enable or disable this option. If Enabled, the following option is available.

* Meta tag attribute name for Nonce: The Attribute name in meta tag where the Nonce value is configured in the website.

<figure><img src="/files/KMfECtATlG003LnfeYc2" alt=""><figcaption></figcaption></figure>

### SDK Setup <a href="#sdksetup" id="sdksetup"></a>

To set up Ingest Labs SDK, you must include the following script tag in index.html file of the website. Once the script is executed, the SDK is installed on the client website.

![sdksetup](https://ingest-lab.netlify.app/images/environmentsimages/sdksetup.png)

The following is the SDK URL that you must embed in the Staging environment of the client website. The first party domain is mp.ingestlabs.com and the Project ID in the sdk url is MPcl02kskp1eha030nh7hnn. In the IDL Setup, the idl.js file is Identity Link or First party identity script file. The following is the IDL setup url that you must embed in the Staging environment of the client website:

![viewstagingenvironment](https://ingest-lab.netlify.app/images/environmentsimages/stagingcode.png)

### Approved Domains and Collector URLs <a href="#approveddomainsandcollectorurls" id="approveddomainsandcollectorurls"></a>

The Approved Domains has the list of domains on which the SDK will run. The SDK will execute only these listed domains. This is to avoid spamming and to ensure that the SDK of one site is not used on another site.

The Script sdk url changes when the domain is verified based on the data collector configuration. This decides which collector url to pick based on what domain. Collector url is the url to which Server Side Tags and report calls are sent.

![datacollectordomain](https://ingest-lab.netlify.app/images/environmentsimages/datacollectordomain.png)

The Approved Domains & Collector URLs display the following information:

* **Domain** – Enter your website domain in this field.
* **Collector URL** – This displays the URL where the collected data is sent.

<figure><img src="/files/idHTFDbGyx7vx073R151" alt=""><figcaption></figcaption></figure>

**Approved Data Collection Domains** – This section lists the domains that are authorized to collect data.

<figure><img src="/files/TXzsu6mg7r1kxVPwGn2Y" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FaPxWPO5WR1FfRZGvqvP7%2FView%20Staging%20Environment.mp4?alt=media&token=7ff3c0c7-6f23-4313-bcc0-650128fcfd48>" %}


# Settings

## Introduction

The Settings option provides you options to configure the settings for a particular project.

## Procedure

**Step 1:** The Settings screen includes the following information:

<figure><img src="/files/MFqq3uUUS7Ju5fnbof6C" alt=""><figcaption></figcaption></figure>

| Info                       | Description                                                                                            |
| -------------------------- | ------------------------------------------------------------------------------------------------------ |
| Name                       | Name of the project.                                                                                   |
| Description                | Description of the project.                                                                            |
| Project Type               | Denotes the project type.                                                                              |
| Project Framework          | Shows the framework used for the project.                                                              |
| Demand-Side Platform (DSP) | By default, this option is disabled. To enable the DSP in this project, reach out to the Support team. |

**Step 2:** Click **edit** on the top right corner to edit the project name and the description.

<figure><img src="/files/bzwkKmNPZJmfkWPhZ6tk" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Save** to save the changes. Click cancel to revert to the original settings.

<figure><img src="/files/FRF15F9PszOXlrpLXFam" alt=""><figcaption></figcaption></figure>

### Delete a Project <a href="#deleteaproject" id="deleteaproject"></a>

**Step 1:** To delete a project, click the **Actions** dropdown at the top, and then select **Delete Project.**

<figure><img src="/files/1Egm37aoLzwb7ADzt05P" alt=""><figcaption></figcaption></figure>

**Step 2:** Click **OK** in the confirmatory dialog box that appears.

![](https://ingest-lab.netlify.app/images/settingsimages/deleteproject.png)

**Step Result:** The project is deleted.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FR2bHvkGoIn27IsLYeIrc%2FSettings.mp4?alt=media&token=90086db3-54ed-4ac4-b869-28620902c70d>" %}


# Alarms

Alarms are the notifications triggered by specific events or conditions within the Tag Manager of Ingest Labs. Alarm notifications can be set to alert users when a tag expires, or is about to expire, or when there is a sudden anomaly in the tag behavior.

The two types of Alarms are **Tag Anomaly Detection Alarm** and the **Tag Expiration Alarm**.

### Tag Anomaly Detection Alarm <a href="#taganomalydetectionalarm" id="taganomalydetectionalarm"></a>

The tags are typically triggered consistently over time. This regular pattern is monitored using the Bollinger band. However, there could be an anomaly or an abnormal tag behavior with a sudden spike or drop in the tag trigger. You can configure alarms to detect such anomalies in the tag behavior and receive timely notifications.

### Tag Expiration Alarm <a href="#tagexpirationalarm" id="tagexpirationalarm"></a>

When configuring a tag within the Tag Manager, you can specify start and end dates for execution. Alarms can be set to notify configured contacts on tag expiry or just before tags expire. By default, if you do not select any criteria or filters while creating a new alarm, the alarm will be triggered for all configured tags within the project.

Additionally, using the Tag Expiry Look Back feature, you can set alarms in advance, specifying the number of days before tag expiration for reminder notifications and the exact time for alarm triggering.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

The Alarms section includes the following topics:

* [Alarms Screen](/tag-manager/alarms/alarms-screen)
* [Add a New Tag Anomaly Detection Alarm](/tag-manager/alarms/add-a-new-alarm-tag-anomaly-detection-alarm)
* [Add a New Tag Expiration Alarm](https://ingest-lab.netlify.app/tagmanager/alarms/addanewalarmtagexpirationalarm/)
* [Edit an Alarm](/tag-manager/alarms/edit-an-alarm)
* [Delete an Alarm](/tag-manager/alarms/add-funnuel-monitoring-alarm/delete-an-alarm)

[<br>](https://ingest-lab.netlify.app/tagmanager/settings/)


# Alarms Screen

## Introduction

The **Alarms** screen displays information related to alarms in the system. It helps users view, track, and manage alarms easily.

## Procedure

**Alarms (1 of 1)**\
This option indicates the number of Alarms currently displayed out of the total available Alarms.

<figure><img src="/files/7Uol12NLFAvmo8YcD7kH" alt=""><figcaption></figcaption></figure>

**Add Alarms**\
Click the **Alarms** dropdown. You will see the following options:

* **Add Tag Anomaly Detection Alarm**
* **Add Tag Expiration Alarm**
* **Add Funnel Monitoring Alarm**

Details of each option will be explained in their respective documents.

<figure><img src="/files/sUg6SubmAqlU4E50gfrV" alt=""><figcaption></figcaption></figure>

**Click the Refresh**\
A **Fetching Alarms…** message appears while the system retrieves and displays the updated alarm data.

<figure><img src="/files/4SH730yoR9jPiEyPRnMB" alt=""><figcaption></figcaption></figure>

The following UI elements appear on the Alarms screen.

<figure><img src="/files/f6ynMVRzHYL0mfhcj36C" alt=""><figcaption></figcaption></figure>

| Column Name     | Description                                                    |
| --------------- | -------------------------------------------------------------- |
| Name            | Denotes the Alarm Name.                                        |
| Alarm Status    | Denotes the Alarm status.                                      |
| Monitoring Type | Denotes the type of monitoring applied to generate the alarm.  |
| Created By      | Denotes the user who created the alarm.                        |
| Updated By      | Denotes the user who updated the alarm.                        |
| Updated On      | Denotes the time and the date of the last update of the alarm. |

## Configuration of Alarms <a href="#configurationofalarms" id="configurationofalarms"></a>

You can configure one or both of these alarms:

* Tag Anomaly Detection Alarm: To notify contacts when tag anomalies occur.
* Tag Expiration Alarm: To notify contacts when a tag expires.

In Ingest Labs, you can create an alarm for tag expiration and anomaly detection. The configured contacts will receive an alert when an abnormal tag trigger is detected or when a tag expires. You can also set an advance notification for tag expiry using the **Tag Expiry Look Back** feature.


# Add a New Alarm (Tag Anomaly Detection Alarm)

## Introduction

You can create a new Tag Anomaly Detection Alarm to monitor unusual tag activity.

## Procedure

To add a new Tag Anomaly Detection Alarm, perform the following steps:

**Step 1:** Select **Alarms** from the left navigation panel.

<figure><img src="/files/CwC55SXrLm8MdvguE4dj" alt=""><figcaption></figcaption></figure>

**Step 2:** Click **Add Alarm** on the top-right corner of the screen.

<figure><img src="/files/ohpgncJRo09xhQSUu2Qs" alt=""><figcaption></figcaption></figure>

**Step 3:** Select the **Tag Anomaly Detection Alarm**.

<figure><img src="/files/ZZYBhaoBBnJKufTVT1Mq" alt=""><figcaption></figcaption></figure>

**Step 4:** In the **Name** field, enter the alarm name, and in the **Description** field, enter a brief description of the alarm.

<figure><img src="/files/jKeIcOvHJjgH7zo3Nh7F" alt=""><figcaption></figcaption></figure>

**Step 5:** Under **Environment**, click the **Select Environment** dropdown. Two options are available — **Production** and **Staging**. Click the appropriate option.

<figure><img src="/files/NzQkjsleyJctZHtPZOJO" alt=""><figcaption></figcaption></figure>

**Step 6:** Enter the details mentioned in the **Settings** section.

![](https://ingest-lab.netlify.app/images/alarmsimages/alarmsettings.png)

**Threshold Sensitivity:**

* **High** sensitivity: The anomaly detection trigger will fire and send alert if it detects an anomaly at least ONCE in the previous hour.
* **Medium** sensitivity: The anomaly detection trigger will fire and send alert if it detects an anomaly once in the past 2 consecutive hours.
* **Low** sensitivity: The anomaly detection trigger will fire and send alert if it detects an anomaly once in the past 3 consecutive hours.

The Tag behavior is determined using the Bollinger Band.

![](https://ingest-lab.netlify.app/images/alarmsimages/bollingerband.png)

**Preferred Timings:**

Select the exact tag monitoring period from the **Preferred Timings** drop-down. This is an optional setting. For example, If there is a sudden spike in traffic in the evenings, you could set the preferred timing from 5 p.m. to 10 p.m. The tag firing activities will be monitored every evening between 5 p.m. to 10 p.m.

**Note:** The tags are monitored continuously with a set preferred timing.

**Step 6:** Enter the details in the **Filter Conditions** section.

You can make the alarm more specific by creating monitors on specific tags, providers, or other attributes. To filter the alarms, perform the following steps:

* On the alarm page, click **Add Filter**.

| Field Name  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tag         | Specifies the tag to be monitored for anomaly detection.                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Page Name   | <p>Specifies the Page Name to be monitored for anomaly detection.<br>Select either contains or is from the Operator drop-down menu.</p>                                                                                                                                                                                                                                                                                                                                               |
| Provider    | Specifies the Provider that needs to be monitored for anomaly detection.                                                                                                                                                                                                                                                                                                                                                                                                              |
| Device Type | Select this option to display devices such as **Desktop**, **Web**, **Mobile Web**, **Tablet**, and **Other**.                                                                                                                                                                                                                                                                                                                                                                        |
| OS          | Select this option to display information regarding the OS such as **iOS** and **Android**.                                                                                                                                                                                                                                                                                                                                                                                           |
| Language    | Select this option to set the preferred language.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Domain      | Select the appropriate domain name. Select either **contains** or **is** from the **Operator** drop-down menu.                                                                                                                                                                                                                                                                                                                                                                        |
| Status      | <p>Select this option to set to one of the Tag trigger Statuses.<br>• Success (200)<br>• Success (202)<br>• Provider Side Failure (400)<br>• Provider Side Failure (404)<br>• Provider Side Failure (500)<br>• Tag Validation Failure (900)<br>• Tag Validation Failure (1000)<br>• Error (1001)<br>• Privacy Blocked (1002)<br>• Skipped (1003)<br>• Success with Warnings (1004)<br>• Scheduled for retry (1005)<br>• Maximum retry attempts reached (1006)<br>• Delayed (1007)</p> |

* Select the Operator options and select any operator to populate the list of available fields.

![addfilter](https://ingest-lab.netlify.app/images/alarmsimages/addfilter.png)

**Step 7:** Select **Destinations** section.

* **Select Notification Group**: The tag anomaly alert will be sent to the contacts configured in the selected notification group. In this step, you can select the check boxes or search for a particular group.
* **Provide Email ID**: Enter the email IDs of the users to send the notification for tag anomaly. You can add users using the **Add Users** tab.

Note: You can select **Notification Groups**, **Email IDs**, or **both**, based on where you want to send the alerts.

![](https://ingest-lab.netlify.app/images/alarmsimages/notificationgroup.png)

**Step 8:** A message appears at the top saying **Alarm added successfully.**

<figure><img src="/files/VFVIOGRIY32e5c7s4rnd" alt=""><figcaption></figcaption></figure>

**Step 9:** Click **Save** to save the settings.


# Add a New Alarm (Tag Expiration Alarm)

## Introduction

This option allows users to create a new Tag Expiration Alarm. It helps monitor tags and notifies users when a tag is about to expire, enabling timely action.

## Procedure

To add a new alarm, perform the following steps:

**Step 1:** Select **Alarms** from the left navigation panel.

<figure><img src="/files/rgJeCqTVA4UAVKZyxalX" alt=""><figcaption></figcaption></figure>

**Step 2:** Click **Add Alarm** on the top-right corner of the screen.

<figure><img src="/files/OCYgbSwiyCHo19sj47Bd" alt=""><figcaption></figcaption></figure>

**Step 3:** Select **Tag Expiration Alarm**.

<figure><img src="/files/YyyckBniyRT5QbeKz52H" alt=""><figcaption></figcaption></figure>

**Step Result:** The New Tag Expiration Alarm screen appears.

<figure><img src="/files/ufgEEHolqjD04UWpJEiA" alt=""><figcaption></figcaption></figure>

**Step 4:** Enter the following details in the New Tag Expiration Alarm screen.

**Step 5:** In the **Name** field, enter the alarm name. In the **Description** field, enter the alarm description.

<figure><img src="/files/81tsilwlRSH7PwFgsJu8" alt=""><figcaption></figcaption></figure>

**Step 6:** In the Metadata Filters, select a key.

<figure><img src="/files/MSJuCxlLp26dufmZfN6L" alt=""><figcaption></figcaption></figure>

**Step 7:**  Under the Enter Value field, enter the corresponding value.

<figure><img src="/files/hHshd44DQjkgqlwUhiDW" alt=""><figcaption></figcaption></figure>

**Step 8:** The entered values will appear under Selected Values.

<figure><img src="/files/kwJiBRpTDc5dO1wWRbAE" alt=""><figcaption></figcaption></figure>

**Step 9:** To clear the selected values, click Clear.

<figure><img src="/files/WvNGHBgE0IXM7RbWD79P" alt=""><figcaption></figcaption></figure>

**Step 10:** To delete an entry entirely, click Delete.

<figure><img src="/files/Lr8vmXlrC62k2wVeKTaF" alt=""><figcaption></figcaption></figure>

**Note:** You can add multiple filters by clicking Add.

<figure><img src="/files/tjHisOyhfEkGd3IwcNUP" alt=""><figcaption></figcaption></figure>

**Settings**

**Step 11:** Enter the details mentioned in the **Settings** section.

a. **Tag Expiry Lookback (in Days)**: Send tag expiration notification before the tag expires. You can choose five durations during which the alert should be sent. The number of days must be between 1-180.

<figure><img src="/files/1zLSBQP2X9CPaN04LwdZ" alt=""><figcaption></figcaption></figure>

b. **Report Time:** Select the time to trigger the tag expiration alarm. The timezone is set according to the user time zone.

<figure><img src="/files/X2IBpubQcQfkA1krcnzy" alt=""><figcaption></figcaption></figure>

**Destination**.

**Step 12:** Select **Notification Group**: The tag expiration alert is sent to the contacts configured in the selected notification group. In this step, you can select the check boxes or search for a particular group.

![](https://ingest-lab.netlify.app/images/alarmsimages/notificationgrouptagexpiration.png)

**Step 13:** Provide **Email ID**: Enter the e-mail IDs to send the tag anomaly notification. You can add users using the **Add Users** tab.

Note: You can select **Notification Groups**, **Email IDs**, or **both**, based on where you want to send the alerts.

**Step 14:** Click **Save** to save the settings.

**Step 15:** A message appears confirming that the alarm was added successfully.

<figure><img src="/files/XxMNWYfiivhvA7QMr4Vp" alt=""><figcaption></figcaption></figure>


# Add Funnuel Monitoring Alarm

## **Introduction**

The Funnel Monitoring Alarm is a new alarm added to Tag Manager that provides real-time alerts for specific notifications within your funnels.

## Procedure

**Follow these steps to set up and configure the alarm:**

Navigate to **Tag Manager** > **Alarms**.

<figure><img src="/files/KfaWZw2yKohcxkWQqKk9" alt=""><figcaption></figcaption></figure>

**Step 1:** Click the **Add Alarm** dropdown and select **Add Funnel Monitoring Alarm**.

<figure><img src="/files/sknYEKi3obmd4GUnufER" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/eO3vjxpBAKWU8CQqmYBn" alt=""><figcaption></figcaption></figure>

**Step 2:** Under the **Info** section, the **Name** and **Description** fields are available. In the **Name** field, enter a descriptive name for your Funnel Monitoring Alarm, and in the **Description** field, provide additional details to clarify the purpose or scope of the alarm.

<figure><img src="/files/uLzZ8y9I9caf8QudZGsj" alt=""><figcaption></figcaption></figure>

**Step 3:** Under **Funnel Monitoring Type,** in the **Select Funnel Monitoring Type** dropdown, two options are available:

· Conversion and

· Occurrence

<figure><img src="/files/VwHujNGuuVO5dMIjQedt" alt=""><figcaption></figcaption></figure>

**Step 3.1:** Click **Conversion**.

**Conversion:** This option tracks the percentage of users who progress from adding products to their cart to completing a purchase. For example, if a user visits the website, adds products to the cart but does not complete the purchase, the website owner can use this alarm to monitor the conversion rate. The alarm provides a clear percentage, helping the owner understand how many users are converting from **Add to Cart** to **Purchase**.

**Step 3.1.1:** In the **Event Name** section, provide a clear and descriptive name for the event you want to monitor. Click **Add Event**.

<figure><img src="/files/mOT6rqV8aUxJQNJG0Cj5" alt=""><figcaption></figcaption></figure>

**Step 3.1.2:** Under the **Check Type** dropdown, the following options are available:

· LESS\_THAN

**·** GREATER\_THAN

**·** LESS\_THAN\_EQUAL\_TO, and

**·** GREATER\_THAN\_EQUAL\_T&#x4F;**.**

For example, if you specify **60%** in the **Value** section and select **LESS\_THAN** from the dropdown, a notification will be sent if the monitored percentage falls below 60%. Similarly:

· **GREATER\_THAN** will send a notification if the percentage exceeds 60%.

· **LESS\_THAN\_EQUAL\_TO** will trigger a notification if the percentage is 60% or lower.

· **GREATER\_THAN\_EQUAL\_TO** will send a notification if the percentage is 60% or higher.

<figure><img src="/files/oWd3F1hPNXZ5oyFYonqC" alt=""><figcaption></figcaption></figure>

**Step 3.2**: Click **Occurrence**.

**Step 3.2.1**: In the **Event Name** section, provide a clear and descriptive name for the event you want to monitor.

<figure><img src="/files/tw0KY3f35qFdZqtdD0bp" alt=""><figcaption></figcaption></figure>

**Step 3.2.2**: Under the **Select Threshold Type** dropdown, the following options are available:

* LESS\_THAN
* GREATER\_THAN
* LESS\_THAN\_EQUAL\_TO
* GREATER\_THAN\_EQUAL\_TO

In the **Value** section, specify the numeric threshold you want to monitor. For example, if you select **LESS\_THAN** and enter a value of **50**, the alarm will trigger when the monitored percentage falls below 50%. Similarly:

· Selecting **GREATER\_THAN** will trigger the alarm when the value exceeds the specified threshold.

· **LESS\_THAN\_EQUAL\_TO** will activate the alarm when the value is equal to or less than the threshold.

· **GREATER\_THAN\_EQUAL\_TO** will trigger the alarm when the value is equal to or greater than the threshold.

<figure><img src="/files/wZT3nGLI1W3LoLzYeuKJ" alt=""><figcaption></figcaption></figure>

**Step 4:** Time Window.

Choose how sensitive you want your alarm to be by configuring the time window settings.

Under the **Unit** dropdown, the following options are available:

* HOUR
* DAY
* WEEK
* MONTH

In the **Value** field, specify a numeric value that corresponds to your selected unit. For example:

· If you enter **2** in the **Value** field and select **HOUR** from the dropdown, the alarm will monitor events within a 2-hour time window.

· Similarly, choosing **DAY** with a value of 1 will set the alarm to monitor events within a 1-day period.

<figure><img src="/files/bnu3llKuPTTXjc7AC9KJ" alt=""><figcaption></figcaption></figure>

**Step 5:** Destinations.

Under the **Notification Groups** dropdown, you can select the groups that should receive the notification. By choosing a specific group, all members of that group will be alerted when the alarm is triggered.

Under **Email IDs**, if you want to send the notification to a specific email address in addition to the selected groups, you can enter the email address here. This allows you to add a new user or ensure that a particular individual receives the notification directly.

<figure><img src="/files/7hssag5J20R7tuQH0MzN" alt=""><figcaption></figcaption></figure>


# Delete an Alarm

You can delete a particular alarm.

To delete an alarm in Ingest Labs, perform the following steps:

1. Select the alarm that you want to delete.
2. From the **Actions** drop-down menu on the top right corner, select **Delete**.

![deleteanalarm](https://ingest-lab.netlify.app/images/alarmsimages/deletealarm.png)

3. Click **Yes** on the confirmatory message that appears.

![deleteanalarm](https://ingest-lab.netlify.app/images/alarmsimages/deleteconfirmatory.png)

**Step Result:** The alarm is deleted successfully.


# Edit an Alarm

## Introduction

You can edit the details of a particular alarm.

## Procedure

To edit an alarm in Ingest Labs, perform the following steps:

**Step 1:** Select the alarm that you want to edit.

<figure><img src="/files/aTWB0KkvCzB04AzGGrV8" alt=""><figcaption></figcaption></figure>

**Step 2:** At the top-right corner, the **Actions** drop-down is available. Click the drop-down and select **Edit.**

<figure><img src="/files/MmzQ6QtHzO1HayjrEXyv" alt=""><figcaption></figcaption></figure>

**Step 3:** Edit the alarm details and click **Save** on the top right to save the changes.

<figure><img src="/files/d6I2bHPmVPJz1y1NuHlx" alt=""><figcaption></figcaption></figure>

**Step 4:** You will see a message saying the alarm updated successfully.

<figure><img src="/files/ZbgLjVhyeOrJBcnLtOux" alt=""><figcaption></figcaption></figure>


# Delete an Alarm

## Introduction

You can delete a particular alarm.

## Procedure

To delete an alarm in Ingest Labs, perform the following steps:

**Step 1:** Select the alarm that you want to delete.

<figure><img src="/files/jApu437CF2wjAm8I2yLe" alt=""><figcaption></figcaption></figure>

**Step 2:** At the top-right corner, click the **Actions** drop-down and choose **Delete.**

<figure><img src="/files/zTTdXprj96Z5PxVtGIgc" alt=""><figcaption></figcaption></figure>

**Step 3:** Click **Yes** on the confirmatory message that appears.

![](https://ingest-lab.netlify.app/images/alarmsimages/deleteconfirmatory.png)

**Step Result:** The alarm is deleted successfully.


# About Media Data Platform

Media Data Platform Overview

Ingest Labs' Media Data Platform (MDP) is designed to provide deep insights into visitor behavior on websites. The MDP ensures precise tracking and analysis of visitor journeys, enabling a better understanding of user interactions. Key features include First-Party ID generation, comprehensive visitor journey tracking, and advanced cookie management, all aimed at improving data analysis, visitor insights, and website performance.

### MDP Key Features <a href="#cdpkeyfeatures" id="cdpkeyfeatures"></a>

* **First-Party ID Generation**: Generates a unique First-Party ID for each client, enabling precise tracking and tailored data analysis.
* **First-Party Cookie Identifier**: Creates a first-party cookie identifier for each visitor to track interactions and activities.
* **Comprehensive Visitor Journey Tracking**: Captures detailed journey information for each visitor, including pages viewed, products considered, and interaction sequences.
* **Identifier Generation and Management**: Verifies the presence of existing Visitor IDs and generates new First-Party IDs if necessary, integrating with the Magic Pixel SDK to manage MPIDs.
* **Data Interpretation and Analysis**: Identifies product categories viewed by visitors and generates comprehensive statistics, offering valuable insights into customer behavior.
* **Cookie Management and Domain Handling**: Manages first-party cookies by handling sub-domains to ensure they are treated as first-party.

### MDP Benefits <a href="#cdpbenefits" id="cdpbenefits"></a>

The Ingest Labs MDP offers enhanced visitor insights, personalized user experiences, and improved conversion rates by addressing potential drop-off points. The platform ensures accurate data tracking and collection, leading to reliable insights, and optimizes cookie management complying with privacy standards, and improving data integrity. These features collectively enhance visitor engagement and overall website performance.

* **Enhanced Visitor Insights**: Gain a comprehensive understanding of how visitors navigate and interact with the website. This insight is crucial for optimizing user experience and increasing engagement.
* **Personalized User Experience**: By understanding individual visitor journeys, you can tailor content and recommendations to match interests and preferences, leading to a more personalized and satisfying user experience.
* **Improved Conversion Rates**: Detailed visitor behavior tracking allows for identifying and addressing potential drop-off points in the customer journey, enhancing overall conversion rates.
* **Enhanced Data Accuracy**: The platform ensures accurate tracking and data collection by generating and managing unique identifiers, leading to more reliable insights.
* **Improved User Insights**: Detailed analysis of product categories viewed and comprehensive statistics generation help understand customer preferences and behavior.
* **Optimized Cookie Management**: Proper handling of first-party and third-party cookies ensures compliance with privacy standards and improves data integrity.

## Related Topics <a href="#relatedtopics" id="relatedtopics"></a>

* [About Media Data Platform](/media-data-platform/about-media-data-platform)
* [Dashboard](/media-data-platform/dashboard)
* [Segments](/media-data-platform/segments)
* [Audiences](/media-data-platform/audiences)
* [Connectors](/media-data-platform/connectors)
* [Destinations](/media-data-platform/destinations)
* [Pipelines](/media-data-platform/pipelines)
* [Data Sources](/media-data-platform/data-sources)


# Dashboard

Media Data Platform Dashboard

Two types of dashboards are available:

1. Predefined Dashboard
2. Customizable Dashboard

**Predefined Dashboard**: A predefined dashboard is a ready-made dashboard that is available by default and cannot be modified by users.

Under **Predefined Analytics Dashboards**, the following dashboards are available:

* Analytics ADA Insights
* Google Ads Insights
* Facebook Ads Insights
* Event Flow

**Customizable Dashboard**: A customizable dashboard is a dashboard that users can create and configure by adding, removing, and arranging widgets based on their needs.

## Related Topics: <a href="#relatedtopics" id="relatedtopics"></a>

* [Media Data Platform Dashboard Screen](/media-data-platform/dashboard/insights-dashboard-screen)
* [Create a New MDP Dashboard](/media-data-platform/dashboard/create-a-new-custom-dashboard)
* [Add Widgets in the MDP Dashboard](/media-data-platform/dashboard/add-a-widget-to-the-dashboard)
* [Edit a Widget](/media-data-platform/dashboard/edit-a-widget)
* [Export Widget](/media-data-platform/dashboard/debug-a-widget)
* [Refresh Widget](/media-data-platform/dashboard/refresh-a-widget)
* [Delete Widget](/media-data-platform/dashboard/delete-a-widget)
* [Resize Reorder Widgets](/media-data-platform/dashboard/resize-and-reorder-widgets)
* [Edit Dashboard](/media-data-platform/dashboard/edit-dashboard)
* [Switch Dashboard](/media-data-platform/dashboard/switch-dashboard)
* [Add Widget to this MDP Dashboard](/media-data-platform/dashboard/add-a-widget-to-the-dashboard)
* [Make Default Dashboard](broken://pages/P0dKAjxgJIQNHRtCQR9G)
* [Share Dashboard](/media-data-platform/dashboard/share-dashboard)
* [Delete Dashboard](/media-data-platform/dashboard/delete-dashboard)

[<br>](https://ingest-lab.netlify.app/customerdataplatform/aboutcustomerdataplatform/)


# Insights Dashboard Screen

## Introduction

The **Insights Dashboard** is a predefined dashboard.

## Dashboard – Overview Widget

<figure><img src="/files/lHE1xojUtqxoWc3sZUYX" alt=""><figcaption></figcaption></figure>

All widgets display data for the selected time period.

| Dashboard Screen                | Description                                                                         |
| ------------------------------- | ----------------------------------------------------------------------------------- |
| Total Conversions               | Displays the total number of conversions                                            |
| No. of Conversion               | Displays the total count of conversion events recorded                              |
| Average Conversion              | Displays the average conversion value for the selected period                       |
| Total Users                     | Displays the total number of users who accessed                                     |
| First Visits by Users           | Displays the number of first-time visits by both registered and unregistered users. |
| First Visits by Anonymous       | Displays the number of first-time visits by anonymous users                         |
| Returning Anonymous             | Displays the number of returning anonymous users                                    |
| First Visits by Logged-in Users | Displays the number of first-time visits by logged-in users                         |
| Returning Known Users           | Displays the number of returning registered users                                   |

Click the **Refresh** button to refresh all the widgets on the dashboard.

<figure><img src="/files/aLbbWumubTH36mvDAvUf" alt=""><figcaption></figcaption></figure>

When you hover over a widget, the following options are displayed.

**As of \<date and time>** – Shows the date and time when the widget data was last updated.

**Refresh icon** – Refreshes only the selected widget and loads the latest data.

<figure><img src="/files/ZB1iiqRKZJ31b2VA41er" alt=""><figcaption></figcaption></figure>

## Trend indicator

This indicator shows the percentage change in the widget value compared to the previous period.

A **red downward arrow with a percentage** indicates that the value has **decreased** compared to the previous date range.

<figure><img src="/files/WmRxlrCtKSyvc33VYykO" alt=""><figcaption></figcaption></figure>

A **green upward arrow** (if shown) indicates that the value has **increased** compared to the previous date range.

<figure><img src="/files/fOBfjtky8fdvW1B1MCfL" alt=""><figcaption></figcaption></figure>

## Date and Time Range

Use the Date and Time Range filter to select the period for which the widget data is displayed.

<figure><img src="/files/AUVh829LBtrSbKhwPkHK" alt=""><figcaption></figcaption></figure>

Note: By default, the Dashboard is set to display the data for the last 7 days.&#x20;

Displays the currently selected start and end dates. At the moment, the dashboard is set to display data for the last seven days.

<figure><img src="/files/wK74hCYhmJ2yywByCABs" alt=""><figcaption></figcaption></figure>

Click the drop-down to select a predefined date range, such as Today, Yesterday, Last 7 Days, This Month, or Previous Month. By default, *Last 7 Days* is selected.

<figure><img src="/files/0ix1dxyj4CWFrljirR7E" alt=""><figcaption></figcaption></figure>

You can use the slider to select the time range, and the selected time is displayed next to it.

<figure><img src="/files/XdTTGj4qj5uqAHyecbex" alt=""><figcaption></figcaption></figure>

Select the start and end dates directly from the calendar.

<figure><img src="/files/5eLwM7gkUgd82baycwUA" alt=""><figcaption></figcaption></figure>

Use the left and right arrows to move between months.

<figure><img src="/files/RtNxAe7QA1dKZaml35fY" alt=""><figcaption></figcaption></figure>

Click ***Apply*** to apply the selected date and time range.

<figure><img src="/files/6i33d7Y66Bk2tpNiaAww" alt=""><figcaption></figcaption></figure>

Click *Cancel* to discard your changes and close the filter.

<figure><img src="/files/xKO2vVLfWckbJGnefNC9" alt=""><figcaption></figcaption></figure>

### Top 10 Sales Campaigns Widget

**Campaign ID**: Displays the unique identifier of the sales campaign.

**No. of Conversations**: Displays the total number of conversations associated with the campaign.

**Total Conversion Value** shows the total value generated from the campaign.

<figure><img src="/files/HHTJ5H32iyiUVAPocbJl" alt=""><figcaption></figcaption></figure>

The text Showing **1 to 10 of 127** indicates the range of records currently displayed and the total number of available records.

The page numbers allow users to directly navigate to a specific page.

The Previous and Next icons allow users to move to the previous or next page.

The First and Last icons allow users to jump to the first or last page of the results.

<figure><img src="/files/i31Fk8jjAoUEyPm0SvTB" alt=""><figcaption></figcaption></figure>

When you hover over, the following options are available:

**As of (time)** – Displays the date and time when the widget data was last updated.

**Export to CSV** – Downloads the widget data in CSV format.

**Refresh widget** – Refreshes the widget to load the latest data.

<figure><img src="/files/gUKd0cDeyE4DorKZ4sUz" alt=""><figcaption></figcaption></figure>

### Top Sales Campaign Referrers Widget

**Campaign Referrer Domain**: Displays the domain from which the campaign traffic originated.

**No. of Conversations**: Displays the total number of conversations generated from the referrer.

**Total Conversion Value**: Displays the total value of conversions generated from the referrer.

<figure><img src="/files/frxuPIombIC3VGEbYJ2f" alt=""><figcaption></figcaption></figure>

The text Showing **11 to 20 of 23** indicates the range of records currently displayed and the total number of available records.

The page numbers allow users to directly navigate to a specific page.

The Previous and Next icons allow users to move to the previous or next page.

The First and Last icons allow users to jump to the first or last page of the results.

<figure><img src="/files/JYI7q83GLG0Ipp3ewssO" alt=""><figcaption></figcaption></figure>

When you hover over, the following options are available:

**As of (time)** – Displays the date and time when the widget data was last updated.

**Export to CSV** – Downloads the widget data in CSV format.

**Refresh widget** – Refreshes the widget to load the latest data.

<figure><img src="/files/AtRUv4YJrzYBC71Dinkr" alt=""><figcaption></figcaption></figure>

### Ingest Labs CRM Comparison Widget

**Conversion Date**: Displays the date on which the conversion occurred.

**Data Source**: Displays the source system from which the CRM data is obtained.

**Sales Channel**: Displays the sales channel associated with the conversion.

<figure><img src="/files/DqgSH5TNJV5Otoax11ZL" alt=""><figcaption></figcaption></figure>

The text Showing **11 to 20 of 24** indicates the range of records currently displayed and the total number of available records.

The page numbers allow users to directly navigate to a specific page.

The Previous and Next icons allow users to move to the previous or next page.

The First and Last icons allow users to jump to the first or last page of the results.

<figure><img src="/files/FX1gXcoM1ZBYOZfAXEvp" alt=""><figcaption></figcaption></figure>

When you hover over, the following options are available:

**As of (time)** – Displays the date and time when the widget data was last updated.

**Export to CSV** – Downloads the widget data in CSV format.

**Refresh widget** – Refreshes the widget to load the latest data.

<figure><img src="/files/gSDI6P6eJbGLJIOV2YKx" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FU3tCMqlXCRhjvWx2o8WV%2FInsights%20Dashboard%20Screen.mp4?alt=media&token=2de5b18f-3ce6-416b-bdff-2e1c081b55d7>" %}


# Analytics Dashboard

The **Analytics Dashboard** provides predefined dashboards to help you monitor and analyze campaign performance and user activity across different channels.

Under the **Analytics Dashboard**, the following dashboards are available:

#### 1. Ad Insights

Provides an overall view of advertising performance across connected ad platforms, including key metrics such as traffic and conversions.

#### 2. Google Ad – Insights

Displays performance data specifically for Google advertising campaigns, such as campaign activity and conversions coming from Google ads.

#### 3. Facebook Ad – Insights

Displays performance data for Facebook advertising campaigns, including traffic and conversions generated from Facebook ads.

#### 4. Event Flow

Shows how users move through different events in the application, helping you understand the user journey and interaction flow.


# Ad Insights

## Introduction

Provides an overall view of advertising performance across connected ad platforms.

## Dashboard – Overview Widget

<figure><img src="/files/CK9heYuD9a9o0Oqn3gN3" alt=""><figcaption></figcaption></figure>

All widgets display data for the selected time period.

| Dashboard Screen   | Description                                                                                     |
| ------------------ | ----------------------------------------------------------------------------------------------- |
| Google Ad Clicks   | Shows how many times users clicked your Google ads.                                             |
| Google Ad Spend    | Shows the total amount of money spent on Google ads.                                            |
| Google CTR         | Shows the click-through rate — how often users clicked the ad after seeing it.                  |
| Google Ad ROAS     | Shows the return on ad spend — how much revenue you earned for the money spent on Google ads.   |
| Facebook Ad Spend  | Shows the total amount of money spent on Facebook ads.                                          |
| Facebook CTR       | Shows the click-through rate — how often users clicked the ad after seeing it.                  |
| Facebook Ad Clicks | Shows how many times users clicked your Facebook ads.                                           |
| Facebook Ad ROAS   | Shows the return on ad spend — how much revenue you earned for the money spent on Facebook ads. |

Click the **Refresh** button to refresh all the widgets on the dashboard.

<figure><img src="/files/spcznoNF1CMf3ATL1fLR" alt=""><figcaption></figcaption></figure>

When you hover over a widget, the following options are displayed.

**As of \<date and time>** – Shows the date and time when the widget data was last updated.

**Refresh icon** – Refreshes only the selected widget and loads the latest data.

<figure><img src="/files/6gM7ZKWoFVQmosdtkuyh" alt=""><figcaption></figcaption></figure>

## Trend indicator

This indicator shows the percentage change in the widget value compared to the previous period.

A **red downward arrow with a percentage** indicates that the value has **decreased** compared to the  previous date range.

<figure><img src="/files/B73NEwcPMSriHAAjjfgc" alt=""><figcaption></figcaption></figure>

A **green upward arrow** indicates that the value has **increased** compared to the  previous date range.

<figure><img src="/files/jAGGc1Tv4bcxsd43Lw6H" alt=""><figcaption></figcaption></figure>

## Date and Time Range

Use the Date and Time Range filter to select the period for which the widget data is displayed.

<figure><img src="/files/dT60uzkrb8eTNrVlOTZH" alt=""><figcaption></figcaption></figure>

Note: By default, the Dashboard is set to display the data for the last 7 days.&#x20;

Displays the currently selected start and end dates. At the moment, the dashboard is set to display data for the last seven days.

<figure><img src="/files/H1Hiaj4DSHimggP9zzjS" alt=""><figcaption></figcaption></figure>

Click the drop-down to select a predefined date range, such as Today, Yesterday, Last 7 Days, This Month, or Previous Month. By default, *Last 7 Days* is selected.

<figure><img src="/files/jJzVafh05N5hyZmSn8lD" alt=""><figcaption></figcaption></figure>

You can use the slider to select the time range, and the selected time is displayed next to it.

<figure><img src="/files/aEuWUwOfxYDhonFTQYqg" alt=""><figcaption></figcaption></figure>

Select the start and end dates directly from the calendar.

<figure><img src="/files/mK62pH3VSI4WcQb1ziXP" alt=""><figcaption></figcaption></figure>

Use the left and right arrows to move between months.

<figure><img src="/files/LT8oTDc0ieXNprRSQWDj" alt=""><figcaption></figcaption></figure>

Click ***Apply*** to apply the selected date and time range.

<figure><img src="/files/hHFzv9aCi7ol3tVqkKxE" alt=""><figcaption></figcaption></figure>

Click ***Cancel*** to discard your changes and close the filter.

<figure><img src="/files/lcGNkzt1Pf4E1uljCUjZ" alt=""><figcaption></figcaption></figure>

## Google Campaign Insights

**Google Campaign Insights** provides a simple, campaign-level view of how your ads are performing on **Google**.

<figure><img src="/files/cS9lK5XMcgOp0lQjEk4G" alt=""><figcaption></figcaption></figure>

The following details are available:

| Google Campaign Insights         | Fields                                                    |
| -------------------------------- | --------------------------------------------------------- |
| Account ID                       | Displays the unique ID of the Google Ads account          |
| Account Name                     | Displays the name of the Google Ads account               |
| Campaign ID                      | Displays the unique ID of the campaign                    |
| Campaign Name                    | Displays the name of the campaign                         |
| CTR (Click-Through Rate)         | Shows how often users clicked the ad after seeing it      |
| Ad Spend                         | Shows the total amount spent on the campaign              |
| Clicks                           | Shows the total number of times users clicked the ad      |
| Impressions                      | Shows how many times the ad was displayed                 |
| ROAS (Return on Ad Spend)        | Shows how much revenue was generated for the amount spent |
| CPM (Cost per 1,000 Impressions) | Shows the cost for every 1,000 ad impressions             |

When you hover over, the following options are available:

**As of** – Displays the date and time when the widget data was last updated.

**Export to CSV** – Downloads the widget data in CSV format.

**Refresh widget** – Refreshes the widget to load the latest data.

<figure><img src="/files/adZC9SnGsb3dC2FMVKKk" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FsAsd63ZEUAnwcWlPPL1W%2FAd%20Insights.mp4?alt=media&token=47489566-b787-48bf-9b8d-5a787152a301>" %}


# Google Ad - Insights

## Introduction

The **Google Ad – Insights** dashboard provides a clear overview of your advertising performance in **Google Ads**, including key metrics such as clicks, impressions, spend, and revenue.

## Dashboard – Overview Widget

<figure><img src="/files/6yU4egqk0tVAoHODknyW" alt=""><figcaption></figcaption></figure>

All widgets display data for the selected time period.

| Dashboard Screen                    | Description                                                              |
| ----------------------------------- | ------------------------------------------------------------------------ |
| CPC (Cost Per Click)                | The average amount spent for each ad click.                              |
| CPM (Cost Per Thousand Impressions) | The cost to show the ad 1,000 times.                                     |
| CTR (Click-Through Rate)            | The percentage of people who clicked the ad after seeing it.             |
| ROAS (Return on Ad Spend)           | The revenue generated for every unit of ad spend.                        |
| Impressions                         | The total number of times the ad was shown                               |
| Clicks                              | The total number of times users clicked the ad.                          |
| Spend                               | The total amount spent on ads during the selected date range.            |
| Revenue                             | The total revenue generated from the ads during the selected date range. |

Click the **Refresh** button to refresh all the widgets on the dashboard.

<figure><img src="/files/HI9txbFitOiosBmqVy3c" alt=""><figcaption></figcaption></figure>

When you hover over a widget, the following options are displayed.

**As of \<date and time>** – Shows the date and time when the widget data was last updated.

**Refresh icon** – Refreshes only the selected widget and loads the latest data.

<figure><img src="/files/YF4TTAglRnsmUa75Vmg9" alt=""><figcaption></figcaption></figure>

## Trend indicator

This indicator shows the percentage change in the widget value compared to the previous period.

A **red downward arrow with a percentage** indicates that the value has **decreased** compared to the previous date range.

<figure><img src="/files/VOFTGbW16fj7SUlrqcAA" alt=""><figcaption></figcaption></figure>

A **green upward arrow** indicates that the value has **increased** compared to the previous date range.

<figure><img src="/files/lEYPd0OZYQqdY4etgUnR" alt=""><figcaption></figcaption></figure>

## Date and Time Range

Use the Date and Time Range filter to select the period for which the widget data is displayed.

<figure><img src="/files/b9rJ8BNMfsKREyD4hH4r" alt=""><figcaption></figcaption></figure>

Note: By default, the Dashboard is set to display the data for the last 7 days.&#x20;

Displays the currently selected start and end dates. At the moment, the dashboard is set to display data for the last seven days.

<figure><img src="/files/OztyuEq8bLLKtzcW7RKW" alt=""><figcaption></figcaption></figure>

Click the drop-down to select a predefined date range, such as Today, Yesterday, Last 7 Days, This Month, or Previous Month. By default, *Last 7 Days* is selected.

<figure><img src="/files/aw2AgxHmdgh6Vm69rA8Z" alt=""><figcaption></figcaption></figure>

You can use the slider to select the time range, and the selected time is displayed next to it.

<figure><img src="/files/3Jnc2aJNekQNkL04cMnk" alt=""><figcaption></figcaption></figure>

Select the start and end dates directly from the calendar.

<figure><img src="/files/pbSm35fwhr1ZpiTvo57Y" alt=""><figcaption></figcaption></figure>

Use the left and right arrows to move between months.

<figure><img src="/files/LJ1XQsFAB6IqZne9bPI4" alt=""><figcaption></figcaption></figure>

Click ***Apply*** to apply the selected date and time range.

<figure><img src="/files/lPZYkXhShdJFVCQ2wwRx" alt=""><figcaption></figcaption></figure>

Click ***Cancel*** to discard your changes and close the filter.

<figure><img src="/files/jJxTBcVQWqKYxeSx1vFr" alt=""><figcaption></figcaption></figure>

## Google Campaign Insights

**Google Campaign Insights** provides a simple, campaign-level view of how your ads are performing on **Google**.

<figure><img src="/files/3yPvP7o6KYDlW6eaK6ig" alt=""><figcaption></figcaption></figure>

The following details are available:

| Google Campaign Insights         | Fields                                                      |
| -------------------------------- | ----------------------------------------------------------- |
| Account name                     | The name of the Google Ads account.                         |
| Camp (Campaign name)             | The name of the campaign.                                   |
| Adset name                       | The ad group under the selected campaign.                   |
| Ad name                          | The name of the ad.                                         |
| CTR (Click-Through Rate)         | The percentage of users who clicked the ad after seeing it. |
| Ad spend                         | The total amount spent on the ad.                           |
| Clicks                           | The total number of times the ad was clicked.               |
| CPM (Cost per 1,000 impressions) | The cost to show the ad 1,000 times.                        |
| Impressions                      | The total number of times the ad was shown.                 |
| Revenue                          | The total revenue generated from the ad.                    |

When you hover over, the following options are available:

**As of** – Displays the date and time when the widget data was last updated.

**Export to CSV** – Downloads the widget data in CSV format.

**Refresh widget** – Refreshes the widget to load the latest data.

<figure><img src="/files/3kJ7247mXLBdOOiSU7z9" alt=""><figcaption></figcaption></figure>

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaDMDmegqZUJFhJhF4JQG%2Fuploads%2FR3Pv77K3bxANd99krZCS%2FGoogle%20Ad%20-%20Insights.mp4?alt=media&token=798f52b2-7b40-4892-bc77-aae1740c86e5>" %}




---

[Next Page](/llms-full.txt/1)