Skip to main content

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
DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Confirmation referenceconfirmationrefstringXYZ123
CurrencycurrencystringUSD
Amountamountdecimal300.5
Payment typepaymenttypestringCredit Card
Address line 1address1string175 Varick St
Address line 2address1stringFloor 10
ZIP or postal codezipcodestring10014
CountrycountryISO Alpha-2 Country CodeExamples
Mobilemobilestring7325558585
Ageageinteger28
Gendergenderstringm
Credit card BINccbinstring372888
LanguagelanguagestringEN
Cart DatacartItemsany complex data type supported (array, object, string)See Cart item data
note

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.

DescriptionAttribute nameFormatPayload example
The major category of the product, also known as the first level of the product taxonomy.majorCatstringApparel & Accessories
The major product category ID.majorCatIDstring123456
The minor category of the product, also known as the second level of the product taxonomy.minorCat1stringClothing
The minor category product ID.minorCat1IDstring123456
The third level of the product taxonomy.minorCat2stringActivewear
The fourth level of the product taxonomy.minorCat3stringBicycle Activewear
The fifth level of the product taxonomy.minorCat4stringBicycle Tights
The product SKUskustring1234
The product name of the product.productNamestringViper Red Women’s Cycling Tights
The quantity of each product in the cart.quantitynumber3
The price of the product.pricenumber89.9
The total number of products purchased.numberOfProductsnumber1
The description of the product.productDescriptionstringSporting a reflective design, our long cycling pants for…
The URL of the product image.productImageURLURLhttps://www.cycling.com/womenstights

Ticketing and entertainment

DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Address line 1address1string175 Varick Street
Address line 2address2stringFloor 10
CitycitystringNew York
StatestatestringNY
ZIP or postal codezipcodestring10014
CountrycountryISO Alpha-2 Country CodeExamples
Mobilemobilestring7325558585
Ageageinteger28
Gendergenderstringm
Confirmation referenceconfirmationrefstringXYZ123
CurrencycurrencystringUSD
Amountamountdecimal300.5
Payment typepaymenttypestringCredit Card
Credit card BINccbinstring372888
LanguagelanguagestringEN
Major CategorymajorcatstringConcerts
Minor CategoryminorcatstringR&B
Number of Ticketsnoticketsnumber4
Event NameeventnamestringJohn Smith Featuring the Smiths: Live
EventIDeventidstringE017448281A
Event DescriptioneventdescriptionstringThe most incredible show on earth.
Event Dateeventdateyyyymmdd20200822
Event Timeeventtime24 hour Format0800
Event Zip CodeeventzipcodezipcodeFormat Examples
Event VenueeventvenuestringAustin Big Stadium
Primary Artist NameprimaryartistnamestringJohn Mayer

Travel

DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Address line 1address1string175 Varick St
Address line 2address2stringFloor 10
CitycitystringNew York
StatestatestringNY
ZIP or postal codezipcodestring10014
CountrycountryISO Alpha-2 Country CodeExamples
Mobilemobilestring7325558585
Ageageinteger28
Gendergenderstringm
Confirmation referenceconfirmationrefstringXYZ123
CurrencycurrencystringUSD
LanguagelanguagestringEN
Amountamountdecimal300.5
Payment typepaymenttypestringCredit Card
Credit card BINccbinstring372888
Travel timetraveltime24 hour format1930
Travel datetraveldateyyyymmdd20200408
Destination citydestcitystringNew York
Destination AirportdestairportCode (IATA)Examples
Destination Airport Zip CodedestairportzipcodezipcodeExamples
Departure CitydepartcityStringSydney
Departure AirportdepartairportCode (IATA)Examples
Departure Airport Zip CodedepartairportzipcodezipcodeExamples
Number of passengerspaxnumber2
Trip typetriptypestringBusiness
Loyalty programloyaltyprogramstringStar Alliance
Loyalty tierloyaltytierstring1
Excess baggageexcessbaggagebooleanNo
Travel classtravelclassstringBusiness
CarriercarrierstringNippon Airways
Booked HotelbookedhotelbooleanYes
Purchased insurancepurchasedinsurancebooleanNo
Booked carcarbookedbooleanYes

Retail

DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Address line 1address1string175 Varick St
Address Line 2address2stringFloor 10
CitycitystringNew York
StatestatestringNY
CountrycountryISO Alpha-2 Country CodeExamples
ZIP or postal codezipcodestring10014
Mobilemobilestring7327572923
Amountamountdecimal300.5
CurrencycurrencystringUSD
Credit card BINccbinstring372888
Payment typepaymenttypestringCredit Card
Confirmation referenceconfirmationrefstringXYZ123
Coupon CodecouponcodestringVIP10
LanguagelanguagestringEN
Client Customer IDclientcustomeridstring123-xyz-456
Customer typecustomertypeguest / memberguest
Loyalty programloyaltyprogramstringMacy’s Rewards
Loyalty tierloyaltytierstring1
GiftgiftbooleanYes
Retail Credit CardretailcreditcardbooleanYes
Pricepricedecimal300.5
Quantityquantityinteger3
Major CategorymajorcatstringClothing
Minor CategoryminorcatstringShoes
Product NameproductnamestringBrooks Brothers Brown Loafer
SkustringstringDSC-HX99

Food and beverage

DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Address line 1address1string175 Varick St
Address line 2address2stringFloor 10
CitycitystringNew York
StatestatestringNY
ZIP or postal codezipcodestring10014
CountrycountryISO Alpha-2 Country CodeExamples
Ageageinteger28
Gendergenderstringm
Mobilemobilestring7325558585
Confirmation referenceconfirmationrefstringXYZ123
LanguagelanguagestringEN
CurrencycurrencystringUSD
Amountamountdecimal300.5
Payment typepaymenttypestringCredit Card
Credit card BINccbinstring372888
DeliverydeliveryboolenYes/no
Mobilemobilestring7327572923
Loyalty programloyaltyprogramstringChipotle Rewards
Loyalty tierloyaltytierstring1
Pricepricedecimal300.5
Quantityquantityinteger3
Major CategorymajorcatstringMexican Food
Minor CategoryminorcatstringTacos
Product NameproductnamestringSteak Tacos with Guacamole
SkustringstringDSC-HX99

B2B

DescriptionAttribute nameFormatPayload example
Emailemailstringjohn.smith@rokt.com
First namefirstnamestringJohn
Last namelastnamestringSmith
Address line 1address1string175 Varick St
Address Line 2address2stringFloor 10
CitycitystringNew York
StatestatestringNY
ZIP or postal codezipcodestring10014
CountrycountryISO Alpha-2 Country CodeExamples
LanguagelanguagestringEN
Ageageinteger28
Gendergenderstringm
Mobilemobilestring7325558585
Confirmation referenceconfirmationrefstringXYZ123
CurrencycurrencystringUSD
Amountamountdecimal300.5
Payment typepaymenttypestringCredit Card
Credit card BINccbinstring372888
Shipping TypeshippingtypestringPriority Express
Product NameproductnamestringLG Standing Desk
Business NamebusinessnamestringRokt
Loyalty ProgramloyaltyprogramstringStar Alliance
Loyalty Tierloyaltytierstring1
Mobilemobilestring7325558585
Pricepricedecimal300.5
Quantityquantityinteger3
Major CategorymajorcatstringOffice Supplies
Minor CategoryminorcatstringDesks
Product NameproductnamestringLG Standing Desk
SkustringstringDSC-HX99

Appendix

CountryISO Alpha-2 Country Code
AustraliaAU
AustriaAT
BelgiumBE
CanadaCA
DenmarkDK
FinlandFI
FranceFR
GermanyDE
IrelandIE
JapanJP
Netherlands (the)NL
New ZealandNZ
NorwayNO
SingaporeSG
SpainES
SweedenSE
United KingdomUK
United StatesUS
Was this article helpful?