CIOTrackProductInsightsAgentResultClickRequest

public struct CIOTrackProductInsightsAgentResultClickRequest

Struct encapsulating the parameters that can be passed to constructorIO.trackProductInsightsAgentResultClick() function.

  • The ID of the clicked recommended product

    Declaration

    Swift

    public let itemID: String

  • The question that produced the answer containing the clicked recommendation (1-1000 characters)

    Declaration

    Swift

    public let question: String

  • The ID of the product whose page the Product Insights Agent is on

    Declaration

    Swift

    public let seedItemID: String

  • The zero-based position of the clicked item in the list of recommendations

    Declaration

    Swift

    public let position: Int?

  • The name of the product whose page the Product Insights Agent is on

    Declaration

    Swift

    public let seedItemName: String?

  • The variation ID of the product whose page the Product Insights Agent is on

    Declaration

    Swift

    public let seedVariationID: String?

  • The ID of the answer result returned by the Product Insights Agent

    Declaration

    Swift

    public let qnaResultID: String?

  • The name of the clicked recommended product

    Declaration

    Swift

    public let itemName: String?

  • The variation ID of the clicked recommended product

    Declaration

    Swift

    public let variationID: String?

  • The ID used to group events within a single conversation thread

    Declaration

    Swift

    public let threadID: String?

  • The name of the section the item belongs to (defaults to the configured default section, or “Products”)

    Declaration

    Swift

    public let sectionName: String?

  • Additional custom analytics tags to be sent with the event. Merged with the default analytics tags

    Declaration

    Swift

    public let analyticsTags: [String : String]?

  • Create a Product Insights Agent result click request

    Declaration

    Swift

    public init(itemID: String, question: String, seedItemID: String, position: Int? = nil, seedItemName: String? = nil, seedVariationID: String? = nil, qnaResultID: String? = nil, itemName: String? = nil, variationID: String? = nil, threadID: String? = nil, sectionName: String? = nil, analyticsTags: [String : String]? = nil)

    Parameters

    itemID

    The ID of the clicked recommended product
    question

    The question that produced the answer containing the clicked recommendation (1-1000 characters)
    seedItemID

    The ID of the product whose page the Product Insights Agent is on
    position

    The zero-based position of the clicked item in the list of recommendations
    seedItemName

    The name of the product whose page the Product Insights Agent is on
    seedVariationID

    The variation ID of the product whose page the Product Insights Agent is on
    qnaResultID

    The ID of the answer result returned by the Product Insights Agent
    itemName

    The name of the clicked recommended product
    variationID

    The variation ID of the clicked recommended product
    threadID

    The ID used to group events within a single conversation thread
    sectionName

    The name of the section the item belongs to (defaults to the configured default section, or “Products”)
    analyticsTags

    Additional custom analytics tags to be sent with the event. Merged with the default analytics tags