WETZEL_WARNING: Unrecognized JSON Schema.
CategoryScreenViewEvent
CategorySelectEvent
CategorySetScreenViewEvent
CategorySetSelectEvent
CategorySetViewEvent
CategoryViewEvent
OutfitSelectEvent
OutfitViewEvent
ScreenViewEvent
SelectEvent
SkuScreenViewEvent
SkuSelectEvent
SkuViewEvent
ViewEvent
Records that a user has viewed a screen that represents a category.
CategoryScreenViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
category_id | string |
The UUID that represents the category. | ✓ Yes |
client_id | ["null", "string"] |
If logged in, the client’s id. If logged out, null . |
✓ Yes |
locale | string |
The client's I18n value for localization. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type , schema ). |
buy_it_again_index
: Displays previously purchased skus.category
: Displays products from a single category.category_ungated
: Displays products from a single ungated category.collections_index
: Displays trending for you and complete your looks collections.kept_items_index
: Displays freestyle and fix purchases.saved_items_index'
: Displays skus the client has saved.| ✓ Yes| |platform|string
|The application platform the client is using to view Stitch Fix.| ✓ Yes| |referrer|["null", "string"]
|On web, the referrer URL. On native apps,null
.| ✓ Yes| |region|string
|The identifier for the regional variation of the application that the client is viewing.| ✓ Yes| |schema|string
|A string that describes the shape the event conforms to.| ✓ Yes| |screen_view_id|string
|A UUID generated for the event.| ✓ Yes| |source_app|string
|The fixops name of the application that emitted the event.| ✓ Yes| |type|string
|The type'screen_view'
is shared by all screen view events.| ✓ Yes| |url|["null", "string"]
|On web, the current URL. On native apps,null
.| ✓ Yes| |user_agent|string
|A string describing the client's browser, device, and operating-system.| ✓ Yes| |utm_params|object
|The parsed UTM URL params used to track marketing campaigns, when present.| ✓ Yes| |visitor_id|string
|A unique id that tracks logged-in and logged-out users across all sessions on a single device.| ✓ Yes|
Additional properties are allowed.
The UUID that represents the category.
- Type:
string
- Required: ✓ Yes
If logged in, the client’s id. If logged out, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The client's I18n value for localization.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"en-GB"
"en-US"
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type
, schema
).
buy_it_again_index
: Displays previously purchased skus.category
: Displays products from a single category.category_ungated
: Displays products from a single ungated category.collections_index
: Displays trending for you and complete your looks collections.kept_items_index
: Displays freestyle and fix purchases.saved_items_index'
: Displays skus the client has saved.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"buy_it_again_index"
"category"
"category_ungated"
"collections_index"
"kept_items_index"
"saved_items_index"
The application platform the client is using to view Stitch Fix.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"iOS"
"web"
On web, the referrer URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The identifier for the regional variation of the application that the client is viewing.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"UK"
"US"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_screen_view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The fixops name of the application that emitted the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"categories-next-ui"
"home-ui"
"kept-items-ui"
"shop-collections-ui"
"storybook"
The type 'screen_view'
is shared by all screen view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"screen_view"
On web, the current URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
A string describing the client's browser, device, and operating-system.
- Type:
string
- Required: ✓ Yes
The parsed UTM URL params used to track marketing campaigns, when present.
- Type:
object
- Required: ✓ Yes
A unique id that tracks logged-in and logged-out users across all sessions on a single device.
- Type:
string
- Required: ✓ Yes
Records that a user has selected a UI component that represents a category.
CategorySelectEvent
Properties
Type | Description | Required | |
---|---|---|---|
action_name | string |
The intended result of the action that triggered the event. | ✓ Yes |
category_id | string |
The UUID that represents the category. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema , action_name ). |
✓ Yes |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
select_id | string |
A UUID generated for the event. | ✓ Yes |
type | string |
The type 'select' is shared by all select events. |
✓ Yes |
Additional properties are allowed.
The intended result of the action that triggered the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"navigate_to_category"
The UUID that represents the category.
- Type:
string
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"brand_category_link"
"category_card"
"view_all_link"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_select"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The type 'select'
is shared by all select events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
Records that a user has viewed a screen that represents a category set.
CategorySetScreenViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
category_set_id | string |
The slug that represents the category set. |
Example: 'departments'
.| ✓ Yes|
|client_id|["null", "string"]
|If logged in, the client’s id. If logged out, null
.| ✓ Yes|
|locale|string
|The client's I18n value for localization.| ✓ Yes|
|name|string
|A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type
, schema
).
category_set
: Displays categories in a category set (e.g., departments or brands).| ✓ Yes|
|platform|string
|The application platform the client is using to view Stitch Fix.| ✓ Yes|
|referrer|["null", "string"]
|On web, the referrer URL. On native apps, null
.| ✓ Yes|
|region|string
|The identifier for the regional variation of the application that the client is viewing.| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|screen_view_id|string
|A UUID generated for the event.| ✓ Yes|
|source_app|string
|The fixops name of the application that emitted the event.| ✓ Yes|
|type|string
|The type 'screen_view'
is shared by all screen view events.| ✓ Yes|
|url|["null", "string"]
|On web, the current URL. On native apps, null
.| ✓ Yes|
|user_agent|string
|A string describing the client's browser, device, and operating-system.| ✓ Yes|
|utm_params|object
|The parsed UTM URL params used to track marketing campaigns, when present.| ✓ Yes|
|visitor_id|string
|A unique id that tracks logged-in and logged-out users across all sessions on a single device.| ✓ Yes|
Additional properties are allowed.
The slug that represents the category set.
Example: 'departments'
.
- Type:
string
- Required: ✓ Yes
If logged in, the client’s id. If logged out, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The client's I18n value for localization.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"en-GB"
"en-US"
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type
, schema
).
category_set
: Displays categories in a category set (e.g., departments or brands).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_set"
The application platform the client is using to view Stitch Fix.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"iOS"
"web"
On web, the referrer URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The identifier for the regional variation of the application that the client is viewing.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"UK"
"US"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_set_screen_view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The fixops name of the application that emitted the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"categories-next-ui"
"home-ui"
"kept-items-ui"
"shop-collections-ui"
"storybook"
The type 'screen_view'
is shared by all screen view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"screen_view"
On web, the current URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
A string describing the client's browser, device, and operating-system.
- Type:
string
- Required: ✓ Yes
The parsed UTM URL params used to track marketing campaigns, when present.
- Type:
object
- Required: ✓ Yes
A unique id that tracks logged-in and logged-out users across all sessions on a single device.
- Type:
string
- Required: ✓ Yes
Records that a user has selected a UI component that represents a category set.
CategorySetSelectEvent
Properties
Type | Description | Required | |
---|---|---|---|
action_name | string |
The intended result of the action that triggered the event. | ✓ Yes |
category_set_id | string |
The slug that represents the category set. |
Example: 'departments'
.| ✓ Yes|
|name|string
|A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|select_id|string
|A UUID generated for the event.| ✓ Yes|
|type|string
|The type 'select'
is shared by all select events.| ✓ Yes|
Additional properties are allowed.
The intended result of the action that triggered the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"navigate_to_category_set"
The slug that represents the category set.
Example: 'departments'
.
- Type:
string
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view_all_end_card"
"view_all_link"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_set_select"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The type 'select'
is shared by all select events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
Records that a user has viewed a UI component that represents a category set.
CategorySetViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
category_set_id | string |
The slug that represents the category set. |
Example: 'departments'
.| ✓ Yes|
|name|string
|A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).| ✓ Yes|
|order|object
|An optional object that contains information about the order of the viewed UI relative to its siblings.|No|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|type|string
|The type 'view'
is shared by all view events.| ✓ Yes|
|view_id|string
|A UUID generated for the event.| ✓ Yes|
Additional properties are allowed.
The slug that represents the category set.
Example: 'departments'
.
- Type:
string
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"categories_carousel"
An optional object that contains information about the order of the viewed UI relative to its siblings.
- Type:
object
- Required: No
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_set_view"
The type 'view'
is shared by all view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
Records that a user has viewed a UI component that represents a category.
CategoryViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
category_id | string |
The UUID that represents the category. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema ). |
✓ Yes |
order | object |
An optional object that contains information about the order of the viewed UI relative to its siblings. | No |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
type | string |
The type 'view' is shared by all view events. |
✓ Yes |
view_id | string |
A UUID generated for the event. | ✓ Yes |
Additional properties are allowed.
The UUID that represents the category.
- Type:
string
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"brand_category_link"
"buy_it_again_grid"
"category_card"
"category_recommendations_grid"
"collection_carousel"
"collections_index"
"saved_items_carousel"
"saved_items_grid"
"similar_items_modal"
"ways_to_wear_it_carousel"
An optional object that contains information about the order of the viewed UI relative to its siblings.
- Type:
object
- Required: No
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"category_view"
The type 'view'
is shared by all view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
Records that a user has selected a UI component that represents an outfit.
OutfitSelectEvent
Properties
Type | Description | Required | |
---|---|---|---|
action_name | string |
The intended result of the action that triggered the event. | ✓ Yes |
anchor_sku_id | ["null", "string"] |
The id of the SKU algos uses to generate the outfit. |
Example: In complete-your-looks outfits, the anchor SKU is the item the client already owns.| ✓ Yes|
|name|string
|A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).| ✓ Yes|
|outfit_id|string
|The id that represents the outfit.| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|select_id|string
|A UUID generated for the event.| ✓ Yes|
|type|string
|The type 'select'
is shared by all select events.| ✓ Yes|
Additional properties are allowed.
The intended result of the action that triggered the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"open_quick_view"
The id of the SKU algos uses to generate the outfit.
Example: In complete-your-looks outfits, the anchor SKU is the item the client already owns.
- Type:
["null", "string"]
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"quick_view_cta"
The id that represents the outfit.
- Type:
string
- Required: ✓ Yes
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"outfit_select"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The type 'select'
is shared by all select events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
Records that a user has viewed a UI component that represents an outfit.
OutfitViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
anchor_sku_id | ["null", "string"] |
The id of the SKU algos uses to generate the outfit. |
Example: In complete-your-looks outfits, the anchor SKU is the item the client already owns.| ✓ Yes|
|name|string
|A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).| ✓ Yes|
|order|object
|An optional object that contains information about the order of the viewed UI relative to its siblings.|No|
|outfit_id|string
|The id that represents the outfit.| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|type|string
|The type 'view'
is shared by all view events.| ✓ Yes|
|view_id|string
|A UUID generated for the event.| ✓ Yes|
Additional properties are allowed.
The id of the SKU algos uses to generate the outfit.
Example: In complete-your-looks outfits, the anchor SKU is the item the client already owns.
- Type:
["null", "string"]
- Required: ✓ Yes
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"pager_large_outfit"
"shoppable_outfit"
An optional object that contains information about the order of the viewed UI relative to its siblings.
- Type:
object
- Required: No
The id that represents the outfit.
- Type:
string
- Required: ✓ Yes
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"outfit_view"
The type 'view'
is shared by all view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
Records that a user has viewed a screen.
This generic screen view schema is used for any screen view event that doesn't fit any of our more specific screen view schemas.
ScreenViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
client_id | ["null", "string"] |
If logged in, the client’s id. If logged out, null . |
✓ Yes |
locale | string |
The client's I18n value for localization. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type , schema ). |
categories
: Displays a list of recommended freestyle categories for the client.
exchange
: Displays exchangeable purchases.
freestyle
: Top level Freestyle screen.
homefeed
: Top level client home feed.
order
: Displays previous orders.
post_checkout_promo
: Displays promotions after checkout completes.
return
: Displays returnable purchases.
shopping_bag'
: Displays the client's shopping bag.
storybook'
: Used for local storybook development.| ✓ Yes|
|platform|string
|The application platform the client is using to view Stitch Fix.| ✓ Yes|
|referrer|["null", "string"]
|On web, the referrer URL. On native apps, null
.| ✓ Yes|
|region|string
|The identifier for the regional variation of the application that the client is viewing.| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|screen_view_id|string
|A UUID generated for the event.| ✓ Yes|
|source_app|string
|The fixops name of the application that emitted the event.| ✓ Yes|
|type|string
|The type 'screen_view'
is shared by all screen view events.| ✓ Yes|
|url|["null", "string"]
|On web, the current URL. On native apps, null
.| ✓ Yes|
|user_agent|string
|A string describing the client's browser, device, and operating-system.| ✓ Yes|
|utm_params|object
|The parsed UTM URL params used to track marketing campaigns, when present.| ✓ Yes|
|visitor_id|string
|A unique id that tracks logged-in and logged-out users across all sessions on a single device.| ✓ Yes|
Additional properties are allowed.
If logged in, the client’s id. If logged out, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The client's I18n value for localization.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"en-GB"
"en-US"
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type
, schema
).
categories
: Displays a list of recommended freestyle categories for the client.
exchange
: Displays exchangeable purchases.
freestyle
: Top level Freestyle screen.
homefeed
: Top level client home feed.
order
: Displays previous orders.
post_checkout_promo
: Displays promotions after checkout completes.
return
: Displays returnable purchases.
shopping_bag'
: Displays the client's shopping bag.
storybook'
: Used for local storybook development.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"categories"
"exchange"
"freestyle"
"homefeed"
"order"
"post_checkout_promo"
"return"
"shopping_bag"
"storybook"
The application platform the client is using to view Stitch Fix.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"iOS"
"web"
On web, the referrer URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The identifier for the regional variation of the application that the client is viewing.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"UK"
"US"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"screen_view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The fixops name of the application that emitted the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"categories-next-ui"
"home-ui"
"kept-items-ui"
"shop-collections-ui"
"storybook"
The type 'screen_view'
is shared by all screen view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"screen_view"
On web, the current URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
A string describing the client's browser, device, and operating-system.
- Type:
string
- Required: ✓ Yes
The parsed UTM URL params used to track marketing campaigns, when present.
- Type:
object
- Required: ✓ Yes
A unique id that tracks logged-in and logged-out users across all sessions on a single device.
- Type:
string
- Required: ✓ Yes
Records that a client has actively interacted with a UI component. They fire when a client clicks, taps, or uses the keyboard to trigger an action via a piece of UI.
This generic select schema is used for any select event that doesn't fit any of our more specific select schemas.
SelectEvent
Properties
Type | Description | Required | |
---|---|---|---|
action_name | string |
The intended result of the action that triggered the event. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema , action_name ). |
✓ Yes |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
select_id | string |
A UUID generated for the event. | ✓ Yes |
type | string |
The type 'select' is shared by all select events. |
✓ Yes |
Additional properties are allowed.
The intended result of the action that triggered the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"navigate_to_fixes"
"open_shop_items_modal"
"scroll_to_wtwi"
"view_full_size"
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"order_fix_promo"
"pager_thumbnail"
"pager_thumbnail_outfit"
"see_more_wtwi"
"shop_items_modal_cta"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The type 'select'
is shared by all select events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
Records that a user has viewed a screen that represents a SKU.
SkuScreenViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
client_id | ["null", "string"] |
If logged in, the client’s id. If logged out, null . |
✓ Yes |
locale | string |
The client's I18n value for localization. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type , schema ). |
kept_item
: Displays a details screen for a purchased (or kept) SKU, where the client can manage exchanges, refunds, and feedback.
pdp
: Displays a product details screen.| ✓ Yes|
|platform|string
|The application platform the client is using to view Stitch Fix.| ✓ Yes|
|referrer|["null", "string"]
|On web, the referrer URL. On native apps, null
.| ✓ Yes|
|region|string
|The identifier for the regional variation of the application that the client is viewing.| ✓ Yes|
|schema|string
|A string that describes the shape the event conforms to.| ✓ Yes|
|screen_view_id|string
|A UUID generated for the event.| ✓ Yes|
|sku_id|string
|The id that represents the SKU.| ✓ Yes|
|source_app|string
|The fixops name of the application that emitted the event.| ✓ Yes|
|type|string
|The type 'screen_view'
is shared by all screen view events.| ✓ Yes|
|url|["null", "string"]
|On web, the current URL. On native apps, null
.| ✓ Yes|
|user_agent|string
|A string describing the client's browser, device, and operating-system.| ✓ Yes|
|utm_params|object
|The parsed UTM URL params used to track marketing campaigns, when present.| ✓ Yes|
|visitor_id|string
|A unique id that tracks logged-in and logged-out users across all sessions on a single device.| ✓ Yes|
Additional properties are allowed.
If logged in, the client’s id. If logged out, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The client's I18n value for localization.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"en-GB"
"en-US"
A string that Algos and Product use to identify a distinct group of events. It does not contain information that is recorded by other fields (e.g., type
, schema
).
kept_item
: Displays a details screen for a purchased (or kept) SKU, where the client can manage exchanges, refunds, and feedback.
pdp
: Displays a product details screen.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"kept_item"
"pdp"
The application platform the client is using to view Stitch Fix.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"iOS"
"web"
On web, the referrer URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
The identifier for the regional variation of the application that the client is viewing.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"UK"
"US"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"sku_screen_view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The id that represents the SKU.
- Type:
string
- Required: ✓ Yes
The fixops name of the application that emitted the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"android"
"categories-next-ui"
"home-ui"
"kept-items-ui"
"shop-collections-ui"
"storybook"
The type 'screen_view'
is shared by all screen view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"screen_view"
On web, the current URL. On native apps, null
.
- Type:
["null", "string"]
- Required: ✓ Yes
A string describing the client's browser, device, and operating-system.
- Type:
string
- Required: ✓ Yes
The parsed UTM URL params used to track marketing campaigns, when present.
- Type:
object
- Required: ✓ Yes
A unique id that tracks logged-in and logged-out users across all sessions on a single device.
- Type:
string
- Required: ✓ Yes
Records that a user has selected a UI component that represents a SKU.
SkuSelectEvent
Properties
Type | Description | Required | |
---|---|---|---|
action_name | string |
The intended result of the action that triggered the event. | ✓ Yes |
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema , action_name ). |
✓ Yes |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
select_id | string |
A UUID generated for the event. | ✓ Yes |
sku_id | string |
The id that represents the SKU. | ✓ Yes |
type | string |
The type 'select' is shared by all select events. |
✓ Yes |
Additional properties are allowed.
The intended result of the action that triggered the event.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"add_to_bag"
"buy_now"
"navigate_to_pdp"
"save_item"
"unsave_item"
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
, action_name
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"add_to_bag_cta"
"buy_now_cta"
"move_to_bag_cta"
"pager_large_outfit"
"save_bookmark"
"shoppable_outfit"
"sku_card"
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"sku_select"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
The id that represents the SKU.
- Type:
string
- Required: ✓ Yes
The type 'select'
is shared by all select events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"select"
Records that a user has viewed a UI component that represents a SKU.
SkuViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema ). |
✓ Yes |
order | object |
An optional object that contains information about the order of the viewed UI relative to its siblings. | No |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
sku_id | string |
The id that represents the SKU. | ✓ Yes |
type | string |
The type 'view' is shared by all view events. |
✓ Yes |
view_id | string |
A UUID generated for the event. | ✓ Yes |
Additional properties are allowed.
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"pager"
"shoppable_outfit"
"sku_card"
An optional object that contains information about the order of the viewed UI relative to its siblings.
- Type:
object
- Required: No
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"sku_view"
The id that represents the SKU.
- Type:
string
- Required: ✓ Yes
The type 'view'
is shared by all view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes
A union of all valid event schemas. These events contain the parent_views
and screen_view
contextual fields.
Records that a user has viewed a UI component.
This generic view schema is used for any view event that doesn't fit any of our more specific view schemas.
ViewEvent
Properties
Type | Description | Required | |
---|---|---|---|
name | string |
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type , schema ). |
✓ Yes |
order | object |
An optional object that contains information about the order of the viewed UI relative to its siblings. | No |
schema | string |
A string that describes the shape the event conforms to. | ✓ Yes |
type | string |
The type 'view' is shared by all view events. |
✓ Yes |
view_id | string |
A UUID generated for the event. | ✓ Yes |
Additional properties are allowed.
A string that Algos and Product use to identify a distinct group of events. It describes the UI being interacted with. It does not contain information that is recorded by other fields (e.g., type
, schema
).
- Type:
string
- Required: ✓ Yes
- Allowed values:
"empty_category_recommendations"
"error_page"
"order_fix_promo"
"outfit_quick_view_modal"
"pager_thumbnail"
"pager_thumbnail_outfit"
"see_more_wtwi"
"shop_items_modal"
An optional object that contains information about the order of the viewed UI relative to its siblings.
- Type:
object
- Required: No
A string that describes the shape the event conforms to.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
The type 'view'
is shared by all view events.
- Type:
string
- Required: ✓ Yes
- Allowed values:
"view"
A UUID generated for the event.
- Type:
string
- Required: ✓ Yes