This feature is currently in beta.
Parameters are optional objects that can be paired with the Spotify Pixel’s standard and custom events to provide additional details about an event. These details offer additional granularity in the conversion reporting, giving you a deeper look at campaign performance.
Spotify currently supports the standard parameters below:
|
Parameter Name |
Parameter Description | Code Snippets |
Example Code |
Accepted Data |
|
quantity |
Quantity of items added to cart or purchase. |
w.spdt('checkout', { quantity: 'INSERT_QUANTITY', }); |
w.spdt('checkout', { quantity: '3', }); |
Fields.int() |
|
category |
Customizable field used for lead events. | w.spdt('lead', { category: 'INSERT_CATEGORY',}); |
w.spdt('lead', { category: 'Insurance Quote', }); | Fields.string() |
|
currency |
Type of currency for purchase events.
| w.spdt('purchase', { currency: 'INSERT_CURRENCY',}); |
w.spdt('purchase', { currency: 'USD', }); | Fields.string() |
|
is_new_customer |
Track if a customer is new to the site | w.spdt('custom_event_1', { is_new_customer: 'INSERT_IS_NEW_CUSTOMER',}); |
w.spdt('custom_event_1', { is_new_customer: 'true', }); | Fields.boolean() |
|
product_id |
Unique ID of a product. | w.spdt('addtocart', { product_id: 'INSERT_PRODUCT_ID',}); |
w.spdt('addtocart', { product_id: 'A7k4D9mP3zQ2X1L6', }); | Fields.string() |
|
product_name |
The name of the page or product associated with the event. | w.spdt('addtocart', { product_name: 'INSERT_PRODUCT_NAME',}); |
w.spdt('addtocart', { product_name: 'Topshop Gemma striped crochet grab bag in black stripe', }); | Fields.string() |
|
product_type |
The category of a product (ex: Outerwear or Accessories) | w.spdt('product', { product_type: 'INSERT_PRODUCT_TYPE',}); |
w.spdt('product', { product_type: 'Accessories', }); | Fields.string() |
|
product_vendor |
Used to identify the seller. | w.spdt('product', { product_vendor: 'INSERT_PRODUCT_VENDOR',}); |
w.spdt('product', { product_vendor: 'Adidas', }); | Fields.string() |
|
type |
Customizable field used for lead events. | w.spdt('lead', { type: 'INSERT_TYPE',}); |
w.spdt('lead', { type: 'Home Insurance', }); | Fields.string() |
|
value |
Worth of an item or lead
| w.spdt('purchase', { value: 'INSERT_VALUE',}); |
w.spdt('purchase', { value: '133.55', }); | Fields.float() |
|
variant_id |
Unique ID for a product | w.spdt('addtocart', { variant_id: 'INSERT_VARIANT_ID',}); |
w.spdt('addtocart', { variant_id: 'TSHIRT-1234-RD-M', }); | Fields.string() |
|
variant_name |
Corresponding name to the variant ID |
w.spdt('addtocart', { variant_id: 'VARIANT_NAME', }); |
w.spdt('addtocart', { variant_id: 'Red / Medium / Organic Cotton.', }); | Fields.string() |
|
event_id |
ID given to an event(s) sent to Spotify (used for deduplication) | w.spdt('signup', { event_id: 'INSERT_EVENT_ID',}); |
w.spdt('signup', { event_id: '9XaT2mVz7QL3pF1RcP8q1ZLm7XT9Fr4e', }); | Fields.string() |
| line_items | Additional metadata or unit of information |
w.spdt('purchase', { line_items: 'INSERT_LINE_ITEMS', }); |
w.spdt('purchase', { line_items: value: 22.50 // price quantity: 1, }); |
Fields.list({ }), |
| discount_code | Code for reduced price on a purchase |
w.spdt('purchase', { discount_code: 'INSERT_DISCOUNT_CODE', }); |
w.spdt('custom_event_1', { discount_code: 'SIMMONS', }); |
Fields.string() |
Auto-capture parameters with Spotify Pixel
Parameter auto-capture lets your Spotify Pixel automatically collect supported parameter values from your website without requiring you to add those values manually to your event code.
Auto-capture is supported for the following events and parameters:
|
Parameter |
View Product |
Add to Cart |
Start Checkout |
Purchase |
|
Value |
✓ |
✓ |
✓ |
✓ |
|
Currency |
✓ |
✓ |
✓ |
✓ |
|
Product name |
✓ |
✓ |
— |
— |
|
Product type/category |
✓ |
✓ |
— |
— |
|
Product vendor/brand |
✓ |
✓ |
— |
— |
Auto-capture is not supported for Lead, Sign Up, or custom events. Other parameters, including quantity, discount code, order ID, and line items, must be passed manually.
Enable parameter auto-capture
You can enable parameter auto-capture in two ways:
-
During Spotify Pixel setup: In the Settings section, turn on Automatically capture parameters.
-
For an existing Spotify Pixel: Go to Events, select your dataset, open Settings, and turn on Automatically capture parameters.
You’ll still need to install the applicable event code. Auto-capture fills in supported parameter values for those events; it does not create or fire the event itself.
