CIOTrackProductInsightsAgentViewsRequest

public struct CIOTrackProductInsightsAgentViewsRequest

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

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

    Declaration

    Swift

    public let itemID: String

  • The list of pre-defined questions shown to the user

    Declaration

    Swift

    public let questions: [CIOProductInsightsAgentQuestion]

  • The periods of time during which the Product Insights Agent was visible. Sent as ISO-8601 date-times in UTC

    Declaration

    Swift

    public let viewTimespans: [CIOProductInsightsAgentViewTimespan]

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

    Declaration

    Swift

    public let itemName: String?

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

    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 views request

    Declaration

    Swift

    public init(itemID: String, questions: [CIOProductInsightsAgentQuestion], viewTimespans: [CIOProductInsightsAgentViewTimespan], itemName: String? = nil, variationID: String? = nil, threadID: String? = nil, sectionName: String? = nil, analyticsTags: [String : String]? = nil)

    Parameters

    itemID

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

    The list of pre-defined questions shown to the user
    viewTimespans

    The periods of time during which the Product Insights Agent was visible. Sent as ISO-8601 date-times in UTC
    itemName

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

    The variation ID of the product whose page the Product Insights Agent is on
    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