Skip to content

Commit d64de7a

Browse files
Merge pull request #4346 from segmentio/DOC-654-IG
High Cardinality Source Schema Export (Public Beta)
2 parents 21178c1 + 2e2070b commit d64de7a

File tree

1 file changed

+43
-21
lines changed

1 file changed

+43
-21
lines changed

src/connections/destination-data-control.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,51 +31,73 @@ Destination flags are **case sensitive** and match [the Destination's name in th
3131

3232
If you're on Segment's Business plan, you can filter track calls right from the Segment UI on your Source Schema page by clicking on the field in the "Integrations" column and then adjusting the toggle for each tool. Segment recommends using the UI if possible since it's a much simpler way of managing your filters and can be updated with no code changes on your side.
3333

34-
![](images/destination-control.png)
34+
![A screenshot of the source schema page. The user is hovered over the integrations column, and a popup showing the three integrations connected to the event appears.](images/destination-control.png)
3535

3636
## How do I block or disable specific events and properties from being sent to all Destinations?
3737

3838
If you no longer want to track an event, you can either remove it from your code or, if you're on the Business plan, you can block track calls right from the Segment UI on your Source Schema page by adjusting the toggle for each event.
3939

40-
![](/docs/protocols/images/event-filters.png)
40+
![A screenshot of the source schema page. The toggles in the integrations column are all enabled.](/docs/protocols/images/event-filters.png)
4141

4242
Once you block an event in Segment, Segment stops forwarding it to all of your Destinations, including your warehouses. You can remove it 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. 
4343

4444
## Export your Source Schema
4545

46-
Segment allows you to download your Source Schema as a CSV file, maximizing portability and access to event data. You can download a copy of your schema by visiting the Source Schema page. Track, Identify, and Group events support Source Schema export.
46+
Segment allows users with Source Read-only permissions to download Source Schemas as a CSV file, maximizing portability and access to event data. You can download a copy of your schema by visiting the Source Schema page.
4747

48-
![](images/export-source-schema.png)
48+
> success ""
49+
> You can export Track, Identify, and Group Source Schemas.
4950
50-
You can choose to include properties with the Track events in the modal.
51+
### Download a CSV
52+
You can only download one Source Schema CSV schema type (Track, Identify, or Group) per source at the same time.
5153

52-
![](images/export-source-schema-including-props.png)
54+
To download a Source Schema CSV file:
55+
1. Sign into Segment and select a source.
56+
2. Click the **Schema** tab in the source header.
57+
3. On the Source Schema page, select a schema type (Track, Identify, or Group) and a timeframe (7 days or 30 days.)
58+
4. Click the **Download CSV** button. <br/> A toast pops up on the top of the page, with the message *"Your file is processing. When your file is ready it will be available to download from the Download History page."*
59+
5. Open the Download History page by clicking the link in the toast or following the instructions in the [view download history](#view-download-history) section.
60+
6. Once the file status column indicates that the download was successful, click the **Download CSV** link to download your CSV to your computer. If the file status column shows that the download has failed, return to the Source Schema page and try the download again.<br/> The Source Schema CSV name has the following format:<br/>`workspaceSlug-sourceSlug-schemaType--yyyy-mm-dd--hh-mm-utc`
5361

54-
CSV files generate based on the current view of your Source Schema. Any search parameters or filters you apply to the current Source Schema view also apply to the CSV.
62+
> note "All events and properties are now included in the CSV file"
63+
> When you export a Source Schema, all events and properties are included in the CSV file regardless of the filters or search parameters currently applied to the Source Schema view.
5564
65+
### View download history
66+
67+
You can view the last 14 days' worth of Source Schema exports on the Download History page.
68+
69+
To access the Download History page:
70+
1. Sign into Segment and select a source.
71+
2. Click the **Schema** tab in the source header.
72+
3. Click the **View Download History** link.
73+
74+
### Track event CSV format
5675
The Track event CSV file contains the following columns:
5776
- Event Name
58-
- Property Name (if properties are included in the export dialog)
59-
- Last Seen (UTC)
60-
- If greater than 30 days, the value is "more than 30 days ago"
61-
- Allowed Count
62-
- Blocked Count
63-
- Total Count
77+
- Last Seen At (UTC)
78+
- If greater than your selected timeframe (7 days or 30 days,) the value is "more than 7 days ago" or "more than 30 days ago"
79+
- Property Name
80+
- Allowed
81+
- Blocked
82+
- Total
6483
- Planned (available for Protocols customers with a connected Tracking Plan)
6584
- Values are "planned" or "unplanned"
6685

67-
The Identify & Group CSV file contains the following columns:
86+
> note "Labels in your exported CSV"
87+
> If you use [labels](/docs/protocols/tracking-plan/create/#add-a-label), they appear as columns in your CSV. The column headers are keys, and the column data contains values.
88+
89+
### Identity and Group event CSV format
90+
The Identify and Group CSV files contain the following columns:
6891
- Trait Name
69-
- Last Seen (UTC)
70-
- Allowed Count
71-
- Blocked Count
72-
- Total Count
92+
- Last Seen At (UTC)
93+
- If greater than your selected timeframe (7 days or 30 days,) the value is "more than 7 days ago" or "more than 30 days ago"
94+
- Allowed
95+
- Blocked
96+
- Total
7397
- Planned (available for Protocols customers with a connected Tracking Plan)
7498
- Values are "planned" or "unplanned"
7599

76100
> info ""
77-
> The export schema doesn't include actual values (for example, personal data) for the events, properties, and traits you are tracking for a specific source.
78-
79-
101+
> The exported schema doesn't include actual values (for example, personal data) for the events, properties, and traits you are tracking for a specific source.
80102
81103
See the [Segment Schema Limits](/docs/connections/schema-unique-limits/) for more information on how to manage the Source Schema.

0 commit comments

Comments
 (0)