Profile attributes in the Customer Data Platform are populated with values from events on your website or those sent through the profile update API. For example, the user attribute Medium collects values from the event data key analytics.medium.
When creating custom attributes — either through the UI or the attributes API — you specify which event data key will supply the values. You can use an existing event data key already associated with another attribute (allowing you to collect the same data twice, possibly with different aggregations), or you can specify a new key to collect data independently.
Events sent through the profile update API can include values for both analytics event data keys and custom keys configured when creating custom attributes. This allows you to update profile data gathered from your website or enrich profiles with information from other sources, like a CRM system.
Here’s an example profile update request body:
JSON
{
"identifiers": {
"user_id": "[email protected] "
},
"attributes": {
"analytics.medium": "newsletter",
"crm_user_score": "12"
}
}
The tables below show all event data keys available by default.
Event data key analytics.browser_engine Value description Browser engine Example Gecko Type string
Event data key analytics.browser_language_iso639 Value description Browser language ISO-639 Example en Type string Notes Possible values: browser_language_iso639.json
Event data key analytics.browser_name Value description Browser name Example FF Type string Notes Possible values: browser_name.json
Event data key analytics.browser_version Value description Browser version Example 79.0 Type string
Event data key analytics.campaign_content Value description Campaign content Example textlink Type string
Event data key analytics.campaign_gclid Value description Campaign gclid Example MFIXNyAtIzlqSWgivr-aAfYFHchmPWSuiFI Type string
Event data key analytics.campaign_id Value description Campaign ID Example c0172 Type string
Event data key analytics.campaign_name Value description Campaign name Example spring_sale Type string
Event data key analytics.consent_action Value description Consent action Example 1 Type number Notes Possible values: consent_action.json
Event data key analytics.consent_form_button Value description Consent form button Example 1 Type number Notes Possible values: consent_form_button.json
Event data key analytics.consent_scope Value description Consent scope Example 1 Type number Notes Possible values: consent_scope.json
Event data key analytics.consent_source Value description Consent source Example 1 Type number Notes Possible values: consent_source.json
Event data key analytics.consent_type_ab_testing_personalization Value description Whether users consent to A/B testing and personalization Example true Type bool
Event data key analytics.consent_type_analytics Value description Whether users consent to analytics Example true Type bool
Event data key analytics.consent_type_conversion_tracking Value description Whether users consent to conversion tracking Example true Type bool
Value description Whether users consent to a custom action Example true Type bool
Event data key analytics.consent_type_marketing_automation Value description Whether users consent to marketing automation Example true Type bool
Event data key analytics.consent_type_remarketing Value description Whether users consent to remarketing Example true Type bool
Event data key analytics.consent_type_user_feedback Value description Whether users consent to feedback Example true Type bool
Event data key analytics.content_name Value description Content name Example promo-video Type string
Event data key analytics.cookie_id_hex Value description Cookie identifier Example 8d4dd17c784a6330 Type string Notes When updating the profile, this dimension should be sent in the cookie_id property of identifiers
Event data key analytics.custom_event_action Value description Custom event action Example assignment-submitted Type string
Event data key analytics.custom_event_category Value description Custom event category Example assignment Type string
Event data key analytics.custom_event_name Value description Custom event name Example Math - trigonometry - assignment 4 Type string
Event data key analytics.custom_event_value Value description Custom event value Example 10 Type number
Event data key analytics.device_brand Value description Device brand Example DL Type string Notes Possible values: device_brand.json
Event data key analytics.device_model Value description Device model Example Vostro 3020 MT Type string
Event data key analytics.device_type Value description Device type Example 0 Type number Notes Possible values: device_type.json
Event data key analytics.event_custom_dimension_N Value description Event custom dimension Example size-m Type string
Event data key analytics.event_title Value description Event title Example Piwik PRO Analytics Suite Type string
Event data key analytics.event_type Value description Event type Example 1 Type number Notes Possible values: event_type.json
Event data key analytics.goal_revenue Value description Value of the goal conversion Example 5 Type number
Event data key analytics.goal_uuid Value description UUID of the converted goal Example 18344645-84d3-4544-b870-8df42b24d9f2 Type string
Event data key analytics.is_anonymous Value description Whether the event is anonymous and shouldn't be saved Example false Type bool
Event data key analytics.item_count Value description Ecommerce item count Example 1 Type number
Event data key analytics.keyword Value description Keyword Example git Type string
Event data key analytics.location_city_geoname_id Value description Location city geoname ID Example 11609029 Type number Notes When updating the profile, it must be provided together with location_city_name
Event data key analytics.location_city_name Value description Location city name Example Cambridgeshire Type string Notes When updating the profile, it must be provided together with location_city_geoname_id
Event data key analytics.location_continent_iso_code Value description Location continent ISO code Example EU Type string Notes Possible values: location_continent_iso_code.json
Event data key analytics.location_country_iso_code Value description Location country ISO code Example GB Type string Notes When updating the profile, it must be provided together with location_country_name
Event data key analytics.location_country_name Value description Location country name Example United Kingdom Type string Notes When updating the profile, it must be provided together with location_country_iso_code
Event data key analytics.location_ipv4 Value description IP v4 Example 192.168.1.3 Type ip
Event data key analytics.location_ipv6 Value description IP v6 Example 2001:0db8:0:0::1428:57ab Type ip
Event data key analytics.location_latitude Value description Latitude Example 52.36717 Type number
Event data key analytics.location_longitude Value description Longitude Example 0.00433 Type number
Event data key analytics.location_organization Value description Location organization Example organization Type string
Event data key analytics.location_provider Value description Location provider Example provider Type string
Event data key analytics.location_subdivision_1_iso_code Value description Location subdivision 1 ISO code Example EN Type string Notes When updating the profile, it must be provided together with location_subdivision_1_name
Event data key analytics.location_subdivision_1_name Value description Location subdivision 1 name Example England Type string Notes When updating the profile, it must be provided together with location_subdivision_1_iso_code
Event data key analytics.location_subdivision_2_iso_code Value description Location subdivision 2 ISO code Example CAM Type string Notes When updating the profile, it must be provided together with location_subdivision_2_name
Event data key analytics.location_subdivision_2_name Value description Location subdivision 2 name Example Cambridgeshire Type string Notes When updating the profile, it must be provided together with location_subdivision_2_iso_code
Event data key analytics.medium Value description Medium Example organic Type string
Event data key analytics.operating_system Value description Operating system Example WIN Type string Notes Possible values: operating_system.json
Event data key analytics.operating_system_version Value description Operating system version Example 10 Type string
Event data key analytics.order_id Value description Ecommerce order ID Example 1634 Type string
Event data key analytics.order_time Value description Time of the ecommerce order Example 2023-09-12T09:23:45.000000Z Type datetime
Event data key analytics.referrer_type Value description Referrer type Example 2 Type number Notes Possible values: referrer_type.json
Event data key analytics.resolution Value description Resolution Example 1920x1080 Type string
Event data key analytics.resolution_height Value description Resolution height Example 1080 Type number
Event data key analytics.resolution_width Value description Resolution width Example 1920 Type number
Event data key analytics.revenue Value description Ecommerce order value Example 35.5 Type number
Event data key analytics.revenue_discount Value description Ecommerce order discount Example 5.5 Type number
Event data key analytics.revenue_shipping Value description Ecommerce order shipping Example 10 Type number
Event data key analytics.revenue_subtotal Value description Ecommerce order subtotal Example 25.5 Type number
Event data key analytics.revenue_tax Value description Ecommerce order tax Example 7.23 Type number
Event data key analytics.search_category Value description Search category Example footwear Type string
Event data key analytics.search_keyword Value description Search keyword Example running shoes Type string
Event data key analytics.search_results_count Value description Search results count Example 165 Type number
Event data key analytics.server_time Value description Time of the event Example 2023-09-11T17:39:31.000000Z Type datetime
Event data key analytics.session_custom_dimension_N Value description Session custom dimension Example hight-contrast-on Type string
Event data key analytics.source Value description Source Example google Type string
Event data key analytics.source_medium Value description Source / Medium Example google / organic Type string
Event data key analytics.timing_dom_interactive Value description DOM interactive time (in milliseconds) Example 743 Type number
Event data key analytics.timing_event_end Value description Event end time (in milliseconds) Example 259 Type number
Event data key analytics.user_id Value description User identifier Example [email protected] Type string Notes When updating the profile, this dimension should be sent in the user_id property of identifiers
Event data key analytics.visitor_id_hex Value description Visitor identifier Example af7a891e65ecf95b Type string
