ATS

List of Supported Keys for Meta Conversions API

Suggest Edits

See what events and data can be passed to Meta Conversions API once the integration has been set up.

📘

Attention

The below list of supported keys is subject to change. For the most up-to-date list check Facebook's documentation.

Event Keys

PropertyDescription
event_name
string
Required		A Meta Pixel standard event or custom event name. This field is used to deduplicate events sent by both Meta Pixel and Conversions API. See list of Meta standard event here.
event_id
string
Required		This ID can be any unique string chosen by the advertiser. The event_id and event_name parameters are used to deduplicate events sent by both Meta Pixel and the Conversions API. Note that while event_id is marked optional, it is recommended for event deduplication.
event_time
string
Required		A Unix timestamp in seconds indicating when the actual event occurred. The specified time may be earlier than the time you send the event to Facebook. This is to enable batch processing and server performance optimization. You must send this date in GMT time zone.
​​event_source_url​​
string
Required		The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain.
​​user_data​​
{}
Required		See list of user data keys.
​​custom_data​​
[] 		See list of custom data keys.
​​customer_information​​
[]		See list of customer information keys.

📘

Page View Event

The page view event is already included as a part of your pixel base code. Page view tells you when someone lands on a web page with the pixel base code installed.

User Data Keys

PropertyDescriptionExample
partner_id
string
Required		Must be populated with a Meta-scoped Envelope (without Base64 encoding).'BVOBHAIrEaLRRbGFusikzEyEOEGKVZ0kNPCgRDSoujeTtkmK2OQEGwW7F1lkkQebcPAgAKK58m5A35'
fbc
Click ID
string		The Facebook click ID which value is stored in the _fbc browser cookie under your domain. The format is fb.${subdomain_index}.${creation_time}.${fbclid}.'fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890'
fbp
Browser ID
string		The Facebook browser ID value is stored in the _fbp browser cookie under your domain. The format is fb.${subdomain_index}.${creation_time}.${random_number}.'fb.1.1596403881668.1116446470'

Standard Data Keys

PropertyDescriptionExample
currency
string		The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three-digit currency code.

Required when using Purchase events		'USD'
value
float		A numeric value associated with this event. This could be a monetary value or a value in some other metric.

Required when using Purchase events		142.54
​​content_type
string		Should be set to product or ​product_group​​:
Use ​product​ if the keys you send represent products. Sent keys could be ​content_ids​ or ​contents​​.
 Use ​product_group​ if the keys you send in ​content_ids​​ represent product groups. Product groups are used to distinguish products that are identical but have variations such as color, material, size or pattern.		'product'
content_ids
array		The content IDs associated with the event, such as product SKUs for items in an ​AddToCart​ event. If ​content_type​​ is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values.['ABC123', 'XYZ789']
content_category
string		The category of the content associated with the event.'grocery'
content_name
string		The name of the page or product associated with the event.'lettuce'
delivery_category
string		Type of delivery for a purchase event. Supported values are:
​​in_store​​: Customer needs to enter the store to get the purchased product.
​ ​​curbside​​: Customer picks up their order by driving to a store and waiting inside their vehicle.
* ​​​home_delivery​​: Purchase is delivered to the customer's home.

​​Only applicable for Purchase events​​		'home_delivery'
contents
array		A list of JSON objects that contain the product IDs associated with the event plus information about the products. Available fields: id, quantity, item_price, delivery_category.[{'id':123,'quantity':2,'item_price':5.99}]
num_items
string		The number of items that a user tries to buy during checkout.

​​Only applicable for InitiateCheckout​​ events.		'4'
order_id
string		The order ID for this transaction as a string.'order1234'
predicted_ltv
float		The predicted lifetime value of a conversion event.432.12
search_string
string		A search query made by a user.

​​Only applicable for Search events.		'lettuce'
status
string		The status of the registration event as a string.

​​Only applicable for CompleteRegistration events.		'registered'
​​custom_properties​​Your own custom properties. Custom properties can be used with both standard and custom events, and can help you further define custom audiences.{ "warehouse_location": "washington", "package_size": "L" }

Customer Information Keys

PropertyDefinitionDescriptionUsage
ge
string or list		GenderWe accept gender in the form of an initial in lowercase.'m' or 'f'
subscription_id
string		Subscription IDThe subscription ID for the user in this transaction; it is similar to the order ID for an individual product.'fb.1.1596403881668.1116446470'
ct
string or list		CityWe recommend using Roman alphabet a-z characters. Lowercase only with no punctuation, no special characters, and no spaces. If using special characters, the text must be encoded in UTF-8 format.'london'
st
string or list		StateWe recommend the 2-character ANSI abbreviation code in lowercase. Normalize states outside the U.S. in lowercase with no punctuation, no special characters, and no spaces.'ca'
country
string or list		CountryWe recommend the lowercase, 2-letter country codes in ISO 3166-1 alpha-2.
Important Note: Always include your customers' countries’ even if all of your country codes are from the same country. Facebook matches on a global scale, and this simple step helps Facebook match as many Accounts Center accounts as possible from your list.		'us'
fb_login_id
integer		Facebook Login IDThe ID issued by Meta when a person first logs into an instance of an app. This is also known as App-Scoped ID.
lead_id
integer		Lead IDThe ID associated with a lead generated by Meta's Lead Ads.

Updated about 2 months ago