Skip to content

Commit 3cb7abb

Browse files
authored
Add blurb about Schema view
- Add paragraph explaining what the Schema tab is used for and what's displayed in the UI - Explain that there are 3 tabs - Track, Identify, and Group - Point out that track events are tracked by the entire event and Identify events are tracked by traits and won't show up unless traits are passed in an identify call - Mention that "Page Viewed" will be all Page calls and will show up under the Track tab - Explain the differences in UI display based on whether a tracking plan is connected or not
1 parent 0939b36 commit 3cb7abb

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

src/connections/sources/schema/index.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
---
2-
title: Schema Controls
2+
title: Source Schema
33
redirect_from:
44
- '/protocols/schema/'
55
---
66

77
{% include content/plan-grid.md name="protocols" %}
88

9-
10-
Segment Business plan customers can use Schema Controls to manage which events are allowed to pass through Segment and on to Destinations. These filters are a first-line defense to help you protect the integrity of your data, and the decisions made with it.
9+
Segment Business Tier customers can use Schema Controls to manage which events are allowed to pass through Segment and on to Destinations. These filters are a first-line defense to help you protect the integrity of your data, and the decisions made with it.
1110

1211
Blocking events within the source schema will exclude them from API and MTU calculations. These events are discarded before they reach the pipeline that Segment uses for MTU calculations.
1312

13+
## Schema view
14+
15+
The Schema tab shows the schema of events/properties/traits for each source that Segment receives over a specific timeframe. It also shows when the events were last seen, how many events were allowed vs. blocked, and the downstream destinations those events are connected to.
16+
17+
You can view events by Segment call type in the Source Schema with the **Track**, **Identify**, and **Group** tabs. The Schema tracks Track event details by _event_ name while Identify and Group event details are tracked by _trait_ name. Additional event properties for Page or Track events can be viewed by clicking on the arrow to the left of the event name. Since the Schema tracks **Identify** traits, you will need to make sure you are passing traits into your Identify call in order to view event data in your schema.
18+
19+
The Schema shows "Page Viewed" for all Page calls under the **Track** tab.
20+
21+
The Source Schema UI changes slightly depending on whether you have a [Protocols Tracking Plan](https://segment.com/docs/protocols/tracking-plan/create/){:target='_blank’} connected to the source. If you do have a Tracking Plan connected to your source, the UI will show a **Planned** column that will indicate if the event is planned or unplanned. This allows you to quickly identify unplanned events and take action to align your schema with your Tracking Plan. If there is no Tracking Plan connected to the source, the UI will display a toggle next to each event where, if you're a Business Tier customer, you can simply block or allow that event at the source level. More about event filters below.
22+
1423
## Event filters
1524

1625
If you no longer want to track a specific event, you can either remove it from your code or, if you're on the Business plan and don't have a Tracking Plan connected, you can block track calls from the Segment UI. To do so, click on the Schema tab in a Source and toggle the event to enable or block an event.
@@ -24,7 +33,7 @@ If you no longer want to track a specific event, you can either remove it from y
2433

2534
Once you block an event, Segment stops forwarding it to all of your Cloud and Device-mode Destinations, including your warehouses. You can remove the events from your code at your leisure. In addition to blocking track calls, Business plan customers can block all Page and Screen calls, as well as Identify traits and Group properties.
2635

27-
When an event is blocked, the name of the event or property is added to your Schema page with a counter to show how many events have been blocked. By default, data from blocked events and properties is not recoverable. You can always re-enable the event to continue sending it to downstream Destinations.
36+
When an event is blocked, the name of the event or property is added to your Schema page with a counter to show how many events have been blocked. By default, data from blocked events and properties is not recoverable. You can always re-enable the event to continue sending it to downstream Destinations.
2837

2938
In most cases, blocking an event immediately stops that event from sending to Destinations. In rare cases, it can take **up to six hours** to fully block an event from delivering to all Destinations.
3039

@@ -39,6 +48,8 @@ If you no longer want to capture specific traits within `.identify()` and `.grou
3948
> warning ""
4049
> Blocked traits are not omitted from calls to device-mode Destinations.
4150
51+
Segment's Page call will be
52+
4253
## Schema Integration Filters
4354

4455
All customers can filter specific events from being sent to specific Destinations (except for warehouses) by updating their tracking code. Here is an example showing how to send a single message only to Intercom and Google Analytics:
@@ -62,3 +73,15 @@ Segment Business tier customers can block track calls from delivering to specifi
6273

6374

6475
![Schema integration filters](images/asset_d3SRmkWy.gif "Animation showing how to block events with the toggle switch")
76+
77+
## Schema View
78+
79+
At the top of your source page, you will see a row of tabs.
80+
81+
The Schema tab shows your Source Schema with all events that flow into that source.
82+
83+
Page calls under the hood are Track calls (with some differences) which is why they can show up under Track calls in some areas of the UI.
84+
85+
The Source Schema view has three
86+
87+
"Page Viewed" for all Page calls under the Track tab.

0 commit comments

Comments
 (0)