Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v1.0.0
v1.0.0
  • Overview
  • Guides
    • Creating An Account
    • Getting Started
    • Whisk Sandbox
  • API
    • Authentication
      • Server Token
      • Client Token
      • User Access Token
      • Anonymous Access
    • Recipes
      • Get Recipe
      • Get Recipe Categories
      • Recipe Objects
    • Recipe Discovery
      • Recipe Feed
      • Recipe Search
      • Get Similar Recipes
    • Shopping Lists
      • Get Shopping Lists
      • Create A Shopping List
      • Add Items To A Shopping List
      • List Analysis
    • Meal Plans
      • Meal Plan Management
      • Delete Meals
      • Auto-Generator
      • Error Handling
    • Retailers
      • Get Available Stores
      • Retailers Checkout Flow
      • Retailer Aliases
      • OAuth Retailer Flow
      • Retailer User Info
      • Search Store Items
    • Carts
      • Create a Cart
      • Update Cart Item
      • Splitting Combined Items
      • Add Items To Cart
      • Add Recipes To Cart
      • Get Cart Item Options
      • Swap Cart Item Product
      • Delete A Cart Or A Cart Item
      • Checkout
    • Users
      • Get A User
      • Update A User
    • User Recipes & Collections
      • Add User Recipe
      • Create A Recipe
      • Update External Recipe
      • Get All User Recipes
      • Update User Recipe
      • Remove Recipe from Favorites
      • Create Collection
      • Get All User Collections
      • Get Collection
      • Get Recipes from a Collection
      • Remove Collection
    • Tools
      • Autocomplete
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • Tips and Tricks
    • Object IDs
    • URL Lookup
    • Searching
    • Multiple IDs request
  • Resources
    • Nutrients
    • Recipe Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Supported Retailers
    • Optimizing Image Load
Powered by GitBook
On this page

Was this helpful?

  1. Shopping List SDK
  2. Basic Setup

UTM Parameters

Whisk SDK will automatically send UTM parameters from query search. Like so: ?utm_source=WhiskDevDocs&utm_content=product. Supported parameters are:

ATTRIBUTE

TYPE

DESCRIPTION

utm_campaign

string

Identifies a specific product promotion or strategic campaign.

utm_source

string

Identifies which site sent the traffic, and is a required parameter.

utm_medium

string

Identifies what type of link was used, such as cost per click or email.

utm_content

string

Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link.

utm_term

string

Identifies search terms.

whisk_campaign

string

Identifies a specific product promotion or strategic campaign.

whisk_source

string

Identifies which site sent the traffic, and is a required parameter.

whisk_medium

string

Identifies what type of link was used, such as cost per click or email.

whisk_content

string

Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link.

whisk_term

string

Identifies search terms.

Alternatively, you can define UTM parameters using global configuration.

PreviousGlobal ConfigurationNextUsing With SPA

Last updated 5 years ago

Was this helpful?