Skip to content

Instantly share code, notes, and snippets.

@robwierzbowski

robwierzbowski/docs.md

Last active March 17, 2022 16:18
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save robwierzbowski/ff00f2132b6b45ffa9f4ce592f323dce to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save robwierzbowski/ff00f2132b6b45ffa9f4ce592f323dce to your computer and use it in GitHub Desktop.
Download ZIP
Raw
docs.md

WETZEL_WARNING: Unrecognized JSON Schema.

Objects

CategoryScreenViewEvent

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.

CategoryScreenViewEvent.category_id

The UUID that represents the category.

  • Type: string
  • Required: ✓ Yes

CategoryScreenViewEvent.client_id

If logged in, the client’s id. If logged out, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategoryScreenViewEvent.locale

The client's I18n value for localization.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "en-GB"
    • "en-US"

CategoryScreenViewEvent.name

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"

CategoryScreenViewEvent.platform

The application platform the client is using to view Stitch Fix.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "android"
    • "iOS"
    • "web"

CategoryScreenViewEvent.referrer

On web, the referrer URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategoryScreenViewEvent.region

The identifier for the regional variation of the application that the client is viewing.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "UK"
    • "US"

CategoryScreenViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_screen_view"

CategoryScreenViewEvent.screen_view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

CategoryScreenViewEvent.source_app

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"

CategoryScreenViewEvent.type

The type 'screen_view' is shared by all screen view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "screen_view"

CategoryScreenViewEvent.url

On web, the current URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategoryScreenViewEvent.user_agent

A string describing the client's browser, device, and operating-system.

  • Type: string
  • Required: ✓ Yes

CategoryScreenViewEvent.utm_params

The parsed UTM URL params used to track marketing campaigns, when present.

  • Type: object
  • Required: ✓ Yes

CategoryScreenViewEvent.visitor_id

A unique id that tracks logged-in and logged-out users across all sessions on a single device.

  • Type: string
  • Required: ✓ Yes

CategorySelectEvent

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.

CategorySelectEvent.action_name

The intended result of the action that triggered the event.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "navigate_to_category"

CategorySelectEvent.category_id

The UUID that represents the category.

  • Type: string
  • Required: ✓ Yes

CategorySelectEvent.name

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"

CategorySelectEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_select"

CategorySelectEvent.select_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

CategorySelectEvent.type

The type 'select' is shared by all select events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

CategorySetScreenViewEvent

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.

CategorySetScreenViewEvent.category_set_id

The slug that represents the category set.

Example: 'departments'.

  • Type: string
  • Required: ✓ Yes

CategorySetScreenViewEvent.client_id

If logged in, the client’s id. If logged out, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategorySetScreenViewEvent.locale

The client's I18n value for localization.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "en-GB"
    • "en-US"

CategorySetScreenViewEvent.name

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"

CategorySetScreenViewEvent.platform

The application platform the client is using to view Stitch Fix.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "android"
    • "iOS"
    • "web"

CategorySetScreenViewEvent.referrer

On web, the referrer URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategorySetScreenViewEvent.region

The identifier for the regional variation of the application that the client is viewing.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "UK"
    • "US"

CategorySetScreenViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_set_screen_view"

CategorySetScreenViewEvent.screen_view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

CategorySetScreenViewEvent.source_app

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"

CategorySetScreenViewEvent.type

The type 'screen_view' is shared by all screen view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "screen_view"

CategorySetScreenViewEvent.url

On web, the current URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

CategorySetScreenViewEvent.user_agent

A string describing the client's browser, device, and operating-system.

  • Type: string
  • Required: ✓ Yes

CategorySetScreenViewEvent.utm_params

The parsed UTM URL params used to track marketing campaigns, when present.

  • Type: object
  • Required: ✓ Yes

CategorySetScreenViewEvent.visitor_id

A unique id that tracks logged-in and logged-out users across all sessions on a single device.

  • Type: string
  • Required: ✓ Yes

CategorySetSelectEvent

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.

CategorySetSelectEvent.action_name

The intended result of the action that triggered the event.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "navigate_to_category_set"

CategorySetSelectEvent.category_set_id

The slug that represents the category set.

Example: 'departments'.

  • Type: string
  • Required: ✓ Yes

CategorySetSelectEvent.name

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"

CategorySetSelectEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_set_select"

CategorySetSelectEvent.select_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

CategorySetSelectEvent.type

The type 'select' is shared by all select events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

CategorySetViewEvent

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.

CategorySetViewEvent.category_set_id

The slug that represents the category set.

Example: 'departments'.

  • Type: string
  • Required: ✓ Yes

CategorySetViewEvent.name

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"

CategorySetViewEvent.order

An optional object that contains information about the order of the viewed UI relative to its siblings.

  • Type: object
  • Required: No

CategorySetViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_set_view"

CategorySetViewEvent.type

The type 'view' is shared by all view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

CategorySetViewEvent.view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

CategoryViewEvent

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.

CategoryViewEvent.category_id

The UUID that represents the category.

  • Type: string
  • Required: ✓ Yes

CategoryViewEvent.name

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"

CategoryViewEvent.order

An optional object that contains information about the order of the viewed UI relative to its siblings.

  • Type: object
  • Required: No

CategoryViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "category_view"

CategoryViewEvent.type

The type 'view' is shared by all view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

CategoryViewEvent.view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

OutfitSelectEvent

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.

OutfitSelectEvent.action_name

The intended result of the action that triggered the event.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "open_quick_view"

OutfitSelectEvent.anchor_sku_id

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

OutfitSelectEvent.name

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"

OutfitSelectEvent.outfit_id

The id that represents the outfit.

  • Type: string
  • Required: ✓ Yes

OutfitSelectEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "outfit_select"

OutfitSelectEvent.select_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

OutfitSelectEvent.type

The type 'select' is shared by all select events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

OutfitViewEvent

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.

OutfitViewEvent.anchor_sku_id

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

OutfitViewEvent.name

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"

OutfitViewEvent.order

An optional object that contains information about the order of the viewed UI relative to its siblings.

  • Type: object
  • Required: No

OutfitViewEvent.outfit_id

The id that represents the outfit.

  • Type: string
  • Required: ✓ Yes

OutfitViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "outfit_view"

OutfitViewEvent.type

The type 'view' is shared by all view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

OutfitViewEvent.view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

ScreenViewEvent

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.

ScreenViewEvent.client_id

If logged in, the client’s id. If logged out, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

ScreenViewEvent.locale

The client's I18n value for localization.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "en-GB"
    • "en-US"

ScreenViewEvent.name

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"

ScreenViewEvent.platform

The application platform the client is using to view Stitch Fix.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "android"
    • "iOS"
    • "web"

ScreenViewEvent.referrer

On web, the referrer URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

ScreenViewEvent.region

The identifier for the regional variation of the application that the client is viewing.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "UK"
    • "US"

ScreenViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "screen_view"

ScreenViewEvent.screen_view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

ScreenViewEvent.source_app

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"

ScreenViewEvent.type

The type 'screen_view' is shared by all screen view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "screen_view"

ScreenViewEvent.url

On web, the current URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

ScreenViewEvent.user_agent

A string describing the client's browser, device, and operating-system.

  • Type: string
  • Required: ✓ Yes

ScreenViewEvent.utm_params

The parsed UTM URL params used to track marketing campaigns, when present.

  • Type: object
  • Required: ✓ Yes

ScreenViewEvent.visitor_id

A unique id that tracks logged-in and logged-out users across all sessions on a single device.

  • Type: string
  • Required: ✓ Yes

SelectEvent

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.

SelectEvent.action_name

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"

SelectEvent.name

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"

SelectEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

SelectEvent.select_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

SelectEvent.type

The type 'select' is shared by all select events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

SkuScreenViewEvent

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.

SkuScreenViewEvent.client_id

If logged in, the client’s id. If logged out, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

SkuScreenViewEvent.locale

The client's I18n value for localization.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "en-GB"
    • "en-US"

SkuScreenViewEvent.name

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"

SkuScreenViewEvent.platform

The application platform the client is using to view Stitch Fix.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "android"
    • "iOS"
    • "web"

SkuScreenViewEvent.referrer

On web, the referrer URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

SkuScreenViewEvent.region

The identifier for the regional variation of the application that the client is viewing.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "UK"
    • "US"

SkuScreenViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "sku_screen_view"

SkuScreenViewEvent.screen_view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

SkuScreenViewEvent.sku_id

The id that represents the SKU.

  • Type: string
  • Required: ✓ Yes

SkuScreenViewEvent.source_app

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"

SkuScreenViewEvent.type

The type 'screen_view' is shared by all screen view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "screen_view"

SkuScreenViewEvent.url

On web, the current URL. On native apps, null.

  • Type: ["null", "string"]
  • Required: ✓ Yes

SkuScreenViewEvent.user_agent

A string describing the client's browser, device, and operating-system.

  • Type: string
  • Required: ✓ Yes

SkuScreenViewEvent.utm_params

The parsed UTM URL params used to track marketing campaigns, when present.

  • Type: object
  • Required: ✓ Yes

SkuScreenViewEvent.visitor_id

A unique id that tracks logged-in and logged-out users across all sessions on a single device.

  • Type: string
  • Required: ✓ Yes

SkuSelectEvent

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.

SkuSelectEvent.action_name

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"

SkuSelectEvent.name

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"

SkuSelectEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "sku_select"

SkuSelectEvent.select_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

SkuSelectEvent.sku_id

The id that represents the SKU.

  • Type: string
  • Required: ✓ Yes

SkuSelectEvent.type

The type 'select' is shared by all select events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "select"

SkuViewEvent

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.

SkuViewEvent.name

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"

SkuViewEvent.order

An optional object that contains information about the order of the viewed UI relative to its siblings.

  • Type: object
  • Required: No

SkuViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "sku_view"

SkuViewEvent.sku_id

The id that represents the SKU.

  • Type: string
  • Required: ✓ Yes

SkuViewEvent.type

The type 'view' is shared by all view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

SkuViewEvent.view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes

WETZEL_WARNING: title not defined

A union of all valid event schemas. These events contain the parent_views and screen_view contextual fields.

ViewEvent

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.

ViewEvent.name

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"

ViewEvent.order

An optional object that contains information about the order of the viewed UI relative to its siblings.

  • Type: object
  • Required: No

ViewEvent.schema

A string that describes the shape the event conforms to.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

ViewEvent.type

The type 'view' is shared by all view events.

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "view"

ViewEvent.view_id

A UUID generated for the event.

  • Type: string
  • Required: ✓ Yes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment