Skip to main content

view_item_list

@hyperse-hub/track-plugin-common

Log this event when the user has been presented with a list of items of a certain category.

item_list_id​

Property string

The ID of the list in which the item was presented to the user.

item_list_name​

Property string

The name of the list in which the item was presented to the user.

currency​

Property string required

USD Currency of the items associated with the event, in 3-letter ISO 4217 format.

If you set value then currency is required for revenue metrics to be computed accurately.

value​

Property number required

The monetary value of the event.

  • Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.
  • value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value.
  • currency is required if you set value.

items​

Property Item[] required

The items for the event.