Type Alias TrackingEventInput

Type Declaration

• { path?: string; referrer?: string; title?: string; type: "page_view" }
• { categoryId: string; handle?: string; path?: string; type: "category_viewed" }
• {
      categoryId?: string;
      listId?: string;
      listType?: "category" | "search" | "campaign" | "landing" | string;
      page?: number;
      queryId?: string;
      skus: string[];
      sortBy?: string;
      type: "product_list_viewed";
  }

  • OptionalcategoryId?: string

  • OptionallistId?: string

  • OptionallistType?: "category" | "search" | "campaign" | "landing" | string

  • Optionalpage?: number

  • OptionalqueryId?: string

  • skus: string[]

    SKUs in DISPLAY ORDER — the index is the position. Max 50.

  • OptionalsortBy?: string

  • type: "product_list_viewed"

• {
      categoryId?: string;
      listId?: string;
      listType?: string;
      position?: number;
      sku: string;
      type: "product_clicked";
  }
• {
      categoryId?: string;
      listId?: string;
      placementId?: string;
      position?: number;
      queryId?: string;
      sku: string;
      type: "product_viewed";
  }
• {
      query: string;
      queryId: string;
      resultCount?: number;
      type: "search_submitted";
  }
• {
      position?: number;
      queryId: string;
      sku: string;
      type: "search_result_clicked";
  }
• {
      algorithm?: string;
      placementId: string;
      skus?: string[];
      type: "recommendation_viewed";
  }
• {
      placementId: string;
      position?: number;
      sku: string;
      type: "recommendation_clicked";
  }
• {
      categoryId?: string;
      filters: string[];
      listId?: string;
      queryId?: string;
      type: "filters_applied";
  }
• {
      cartId?: string;
      categoryId?: string;
      listId?: string;
      placementId?: string;
      position?: number;
      quantity?: number;
      queryId?: string;
      sku: string;
      type: "add_to_cart";
  }
• { cartId?: string; quantity?: number; sku: string; type: "remove_from_cart" }
• { categoryId?: string; sku: string; type: "product_favorited" }
• { cartId?: string; type: "checkout_started" }