Choose a version:

Trackable

interface

Represents a resource that you can track the origin of the search traffic.

Anchor to FieldsFields

Anchor to trackingParameterstrackingParameters •String: URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to Article Article •OBJECT: A post that belongs to a Blog. Each article includes content with optional HTML formatting, an excerpt for previews, ArticleAuthor information, and an associated Image.

Articles can be organized with tags and include SEO metadata. You can manage comments when the blog's comment policy enables them.
Anchor to Collection Collection •OBJECT: A group of products organized by a merchant to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.

Query a collection's products with filtering options like availability, price range, vendor, and tags. Each collection includes SEO information, an optional Image, and supports custom data through metafields.
Anchor to Page Page •OBJECT: A custom content page on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.

Each page has a unique handle for URL routing and includes SEO information for search engine optimization. Pages support Metafield attachments for storing additional custom data.
Anchor to Product Product •OBJECT: Represents an item listed in a shop's catalog.

Products support multiple product variants, representing different versions of the same product, and can include various media types. Use the selectedOrFirstAvailableVariant or variantBySelectedOptions fields to help customers find the right variant based on their selections.

Products can be organized into collections, associated with selling plans for subscriptions, and extended with custom data through metafields.

Learn more about working with products and collections.
Anchor to SearchQuerySuggestion SearchQuerySuggestion •OBJECT: A suggested search term returned by the predictiveSearch query. Query suggestions help customers refine their searches by showing relevant terms as they type.

The text field provides the plain suggestion, while styledText includes HTML tags to highlight matching portions. Implements Trackable for analytics reporting on search traffic origins.

Was this section helpful?