Set of methods that allow Eitri shopping apps to interact with Insider SDK.

Methods

  • Logs an event with Insider SDK, where each parameter of the event is defined as a key-value pair within the data object.

    Example:

    await Eitri.exposedApis.insider.logEvent({
    eventName: "product_view",
    data: {
    product_id: "12345",
    category: "electronics",
    price: 99.99
    }
    })

    Parameters

    • param: { eventName: string; data: Record<string, any> }

      Object describing the event.

      • eventName: string

        Name of the event.

      • data: Record<string, any>

        Object describing the event's data.

    Returns Promise<undefined>

  • Tracks homepage visits.

    Example:

    await Eitri.exposedApis.insider.visitHomepage()
    

    Returns Promise<undefined>

  • Tracks listing/category page visits.

    Example:

    await Eitri.exposedApis.insider.visitListingPage({
    taxonomy: ["electronics", "smartphones"]
    })

    Parameters

    • param: { taxonomy: string[] }

      Object containing taxonomy information.

      • taxonomy: string[]

        Array of category strings.

    Returns Promise<undefined>

  • Tracks product detail page visits.

    Example:

    await Eitri.exposedApis.insider.visitProductDetailPage({
    product: {
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }
    })

    Parameters

    Returns Promise<undefined>

  • Tracks cart page visits.

    Example:

    await Eitri.exposedApis.insider.visitCartPage({
    products: [{
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }]
    })

    Parameters

    Returns Promise<undefined>

  • Tracks wishlist page visits.

    Example:

    await Eitri.exposedApis.insider.visitWishlistPage({
    products: [{
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }]
    })

    Parameters

    Returns Promise<undefined>

  • Tracks completed purchases.

    Example:

    await Eitri.exposedApis.insider.itemPurchased({
    saleID: "order_12345",
    product: {
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }
    })

    Parameters

    • param: { saleID: string; product: InsiderProduct }

      Object containing sale and product information.

      • saleID: string

        Unique sale identifier.

      • product: InsiderProduct

        Product object.

    Returns Promise<undefined>

  • Tracks user sign-up confirmations.

    Example:

    await Eitri.exposedApis.insider.signUpConfirmation()
    

    Returns Promise<undefined>

  • Tracks items added to cart.

    Example:

    await Eitri.exposedApis.insider.itemAddedToCart({
    product: {
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }
    })

    Parameters

    Returns Promise<undefined>

  • Tracks items removed from cart.

    Example:

    await Eitri.exposedApis.insider.itemRemovedFromCart({
    productID: "12345"
    })

    Parameters

    • param: { productID: string }

      Object containing product ID.

      • productID: string

        Product identifier.

    Returns Promise<undefined>

  • Tracks when cart is cleared.

    Example:

    await Eitri.exposedApis.insider.cartCleared()
    

    Returns Promise<undefined>

  • Tracks items added to wishlist.

    Example:

    await Eitri.exposedApis.insider.itemAddedToWishlist({
    product: {
    productID: "12345",
    name: "iPhone 15",
    taxonomy: ["electronics", "smartphones"],
    imageURL: "https://example.com/iphone15.jpg",
    price: 999.99,
    currency: "USD"
    }
    })

    Parameters

    Returns Promise<undefined>

  • Tracks items removed from wishlist.

    Example:

    await Eitri.exposedApis.insider.itemRemovedFromWishlist({
    productID: "12345"
    })

    Parameters

    • param: { productID: string }

      Object containing product ID.

      • productID: string

        Product identifier.

    Returns Promise<undefined>

  • Tracks when wishlist is cleared.

    Example:

    await Eitri.exposedApis.insider.wishlistCleared()
    

    Returns Promise<undefined>