Last updated Nov 7, 2024 Partner attributes Including rich, granular data in your SDK integration allows for enhanced targeting and better personalization capabilities—leading to more revenue and better customer experience. You should define these attributes as part of your Web , iOS , Android , or React Native integrations.
You can find the full list of predefined Rokt attributes in the sections below. You can also define any custom attributes to complement the standard integration.
Attribute validation To ensure the reliability of our services, our platform validates Rokt-specific IDs and client data attributes integrated by partners via API SDK integrations, and/or browsers. Validation ensures that data is formatted to meet Rokt platform processing requirements, for example checking for empty strings, or if data types are parseable. Other validation checks look for the correctness and appropriate values, for example, dates of birth being between a specific range or if a phone number is valid.
Core attributes This core list of attributes are integral to successfully deliver relevant offers to your customers Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7325558585 Country country ISO Alpha-2 Country Code Examples Age age integer 28 Gender gender string m Language language string EN Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 Currency currency string USD Cart Data cartItems any complex data type supported (array, object, string) See Cart item data
The following data attributes should be sourced from billing information:
First name Last name Currency Payment type CC Bin Address line 1 Address line 2 Zip or postal code Country amount should come from the final order amount, after any included fees (tax, shipping, etc.).
Cart item data cartItems represent all of the data associated with the customer cart, including, for each product, the product name, product category, quantity, price, SKU, etc. Supports any complex data type containing cart data and should include the following properties for each product in the cart.
Description Attribute name Format Payload example The major category of the product, also known as the first level of the product taxonomy. majorCat string Apparel & Accessories The major product category ID. majorCatID string 123456 The minor category of the product, also known as the second level of the product taxonomy. minorCat1 string Clothing The minor category product ID. minorCatID string 123456 The third level of the product taxonomy. minorCat2 string Activewear The fourth level of the product taxonomy. minorCat3 string Bicycle Activewear The fifth level of the product taxonomy. minorCat4 string Bicycle Tights The product SKU sku string 1234 The product name of the product. productName string Viper Red Women’s Cycling Tights The quantity of each product in the cart. quantity number 3 The price of the product. price number 89.9 The total number of products purchased. numberOfProducts number 1 The description of the product. productDescription string Sporting a reflective design, our long cycling pants for… The URL of the product image. productImageURL URL https://www.cycling.com/womenstights
Ticketing and entertainment Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7325558585 Country country ISO Alpha-2 Country Code Examples Age age integer 28 Gender gender string m Language language string EN Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 City city string New York State state string NY Currency currency string USD Event Name eventname string John Smith Featuring the Smiths: Live EventID eventid string E017448281A Major Category majorcat string Concerts Minor Category minorcat string R&B Number of Tickets notickets number 4 Event Description eventdescription string The most incredible show on earth. Event Date eventdate yyyymmdd 20200822 Event Time eventtime 24 hour Format 0800 Event Zip Code eventzipcode zipcode Format Examples Event Venue eventvenue string Austin Big Stadium Primary Artist Name primaryartistname string John Mayer
Travel Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7325558585 Country country ISO Alpha-2 Country Code Examples Age age integer 28 Gender gender string m Language language string EN Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 City city string New York State state string NY Currency currency string USD Travel date traveldate yyyymmdd 20200408 Travel time traveltime 24 hour format 1930 Destination city destcity string New York Destination Airport destairport Code (IATA) Examples Destination Airport Zip Code destairportzipcode zipcode Examples Departure City departcity String Sydney Departure Airport departairport Code (IATA) Examples Departure Airport Zip Code departairportzipcode zipcode Examples Number of passengers pax number 2 Trip type triptype string Business Loyalty program loyaltyprogram string Star Alliance Loyalty tier loyaltytier string 1 Excess baggage excessbaggage boolean No Travel class travelclass string Business Carrier carrier string Nippon Airways Booked Hotel bookedhotel boolean Yes Purchased insurance purchasedinsurance boolean No Booked car carbooked boolean Yes
Retail Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7327572923 Country country ISO Alpha-2 Country Code Examples Language language string EN Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 City city string New York State state string NY Currency currency string USD Coupon Code couponcode string VIP10 Client Customer ID clientcustomerid string 123-xyz-456 Customer type customertype guest / member guest Loyalty program loyaltyprogram string Macy’s Rewards Loyalty tier loyaltytier string 1 Gift gift boolean Yes Retail Credit Card retailcreditcard boolean Yes Price price decimal 300.5 Quantity quantity integer 3 Major Category majorcat string Clothing Minor Category minorcat string Shoes Product Name productname string Brooks Brothers Brown Loafer SKU string string DSC-HX99 Shipping Address shippingddress1 string 175 Varick St Shipping Address Line 2 shippingaddress2 string Floor 10 Shipping Zipcode shippingzipcode string 10014 OR 10014-1234
Food and beverage Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7325558585 Country country ISO Alpha-2 Country Code Examples Language language string EN Currency currency string USD Age age integer 28 Gender gender string m Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 City city string New York State state string NY Delivery delivery boolen Yes/no Mobile mobile string 7327572923 Loyalty program loyaltyprogram string Chipotle Rewards Loyalty tier loyaltytier string 1 Price price decimal 300.5 Quantity quantity integer 3 Major Category majorcat string Mexican Food Minor Category minorcat string Tacos Product Name productname string Steak Tacos with Guacamole SKU string string DSC-HX99
B2B Description Attribute name Format Payload example Email email string john.smith@rokt.com First name firstname string John Last name lastname string Smith Confirmation reference confirmationref string XYZ123 Billing Zip billingzipcode string 10014 OR 10014-1234 Amount amount decimal 300.5 Payment type paymenttype string Credit Card Credit card BIN ccbin string 372888 Mobile mobile string 7325558585 Country country ISO Alpha-2 Country Code Examples Language language string EN Currency currency string USD Age age integer 28 Gender gender string m Billing Address billingaddress1 string 175 Varick St Billing Address Line 2 billingaddress2 string Floor 10 City city string New York State state string NY Shipping Type shippingtype string Priority Express Product Name productname string LG Standing Desk Business Name businessname string Rokt Loyalty Program loyaltyprogram string Star Alliance Loyalty Tier loyaltytier string 1 Mobile mobile string 7325558585 Price price decimal 300.5 Quantity quantity integer 3 Major Category majorcat string Office Supplies Minor Category minorcat string Desks Product Name productname string LG Standing Desk SKU string string DSC-HX99
Appendix Country ISO Alpha-2 Country Code Australia AU Austria AT Belgium BE Canada CA Denmark DK Finland FI France FR Germany DE Ireland IE Japan JP Netherlands (the) NL New Zealand NZ Norway NO Singapore SG Spain ES Sweeden SE United Kingdom UK United States US