GuidesAPI ReferenceChangelogDiscussions
Log In

📘

Note

All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

A Collection Viewed event will fire whenever a collection is selected. If a user is scrolling through a collection carousel, the event will only fire and be recognized as a view when the full collection is entered, not when it is browsed.

The event properties unique to a Collection Viewed include:

  "event_properties": {
    "source": "direct",
    "event_id": "2D01016A-0B09-44D008ED2-C495EF24B4B3",
    "collection_id": "265425602312",
    "collection_title": "Summer Dresses",
    "collection_view_source": "subcollections_list",
    "custom_block_id": null,
    "custom_block_source_url": null
  }

source String: A value or parameter tracking where the session originated from. This value is stamped on all events of a session. The default is "direct"


event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well


collection_id String : A unique identifier for the collection. Each id is unique across the Shopify system. No two collections will have the same id


collection_title String : The title of the collection viewed


collection_view_source String : The source in which a collection is viewed in the app. Collection views can occur from various pages or screens

Note: To view all the various sources, reference the Event Sources page


custom_block_id String : The unique identifier of the custom code block if applicable


custom_block_source_url String : The unique source url of the custom block that represents the individual block. Will send null if there is no applicable custom block