Skip to content
This repository was archived by the owner on Jun 13, 2025. It is now read-only.

Commit 2203fa5

Browse files
author
DanLee
authored
update to describe screens
1 parent bd9d052 commit 2203fa5

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ segment({
3535
// list of custom fields to extract from the identifies table
3636
customUserFields: ["email", "name", "company_name", "created_at"],
3737
// list of custom fields to extract from the tracks table
38-
customerTrackFields: ["browser_type"]
39-
38+
customerTrackFields: ["browser_type"],
39+
// choose which of tracks, pages and screens to include in the sessionization model
40+
includeTracks: true,
41+
includePages: true,
42+
includeScreens: false,
4043
});
4144
```
4245

@@ -48,7 +51,11 @@ This primary outputs of this package are the following data models (configurable
4851

4952
### `segment_sessions`
5053

51-
Contains a combined view of tracks and pages from segment. Each session is a period of sustained activity, with a new session starting after a 30min+ period of inactivity. Each session contains a repeated field of records which are either tracks or pages. Common fields are extracted out into the top level and type specific fields are kept within two structs: `records.track` and `records.page`.
54+
Contains a combined view of tracks, pages and screens from segment. Each session is a period of sustained activity, with a new session starting after a 30min+ period of inactivity. Each session contains a repeated field of records which are either tracks or pages. Common fields are extracted out into the top level and type specific fields are kept within two structs: `records.track` and `records.page`.
55+
56+
- To create a web-only sessions table, use `includeTracks: true, includePages: true, includeScreens: false`
57+
- To create an app-only sessions table, use `includeTracks: true, includePages: false, includeScreens: true`
58+
- To create a cross-platform sessions table, use `includeTracks: true, includePages: true, includeScreens: true`
5259

5360
### `segment_users`
5461

0 commit comments

Comments
 (0)