Supported Keys for Meta Conversions API
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.
Unless marked as Required, most parameters in this page are optional.
To view more (optional) parameters you can send to Meta, see Meta's documentation "List of Standard Events".
Event Keys
| Property | Description | Web | Mobile |
|---|---|---|---|
event_namestring 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_idstring 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_timestring 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. | ā | ā |
āāapp_dataāā{} | See list of app data keys. | ā | ā |
āācustom_dataāā[] | See list of standard 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
| Property | Description | Example | Web | Mobile |
|---|---|---|---|---|
partner_idstring Required | Must be populated with a Meta-scoped Envelope (without Base64 encoding), which is the value of the value of envelopeSource200 object in your ATS API response. | 'BVOBHAIrEaLRRbGFusikzEyEOEGKVZ0kNPCgRDSoujeTtkmK2OQEGwW7F1lkkQebcPAgAKK58m5A35' | ā | ā |
fbcClick 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' | ā | ā |
fbpBrowser 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
| Property | Description | Example | Web | Mobile |
|---|---|---|---|---|
currencystring | 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' | ā | ā |
valuefloat | 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_typestring | 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_idsarray | 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_categorystring | The category of the content associated with the event. | 'grocery' | ā | ā |
content_namestring | The name of the page or product associated with the event. | 'lettuce' | ā | ā |
delivery_categorystring | 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' | ā | ā |
contentsarray | 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_itemsstring | The number of items that a user tries to buy during checkout. āāOnly applicable for InitiateCheckoutāā events. | '4' | ā | ā |
order_idstring | The order ID for this transaction as a string. | 'order1234' | ā | ā |
predicted_ltvfloat | The predicted lifetime value of a conversion event. | 432.12 | ā | ā |
search_stringstring | A search query made by a user. āāOnly applicable for Search events. | 'lettuce' | ā | ā |
statusstring | 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
| Property | Definition | Description | Usage | Web | Mobile |
|---|---|---|---|---|---|
gestring or list | Gender | We accept gender in the form of an initial in lowercase. | 'm' or 'f' | ā | ā |
subscription_idstring | Subscription ID | The subscription ID for the user in this transaction; it is similar to the order ID for an individual product. | 'fb.1.1596403881668.1116446470' | ā | ā |
ctstring or list | City | We 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' | ā | ā |
ststring or list | State | We 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' | ā | ā |
countrystring or list | Country | We 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_idinteger | Facebook Login ID | The ID issued by Meta when a person first logs into an instance of an app. This is also known as App-Scoped ID. | ā | ā | |
lead_idinteger | Lead ID | The ID associated with a lead generated by Meta's Lead Ads. | ā | ā |
App Data Keys
| Property | Definition | Description | Usage | Web | Mobile |
|---|---|---|---|---|---|
advertiser_tracking_enabledboolean | Advertiser Tracking Permission | Use this field to specify ATT permission on an iOS 14.5+ device. Set to 0 for disabled or 1 for enabled. | '0' or '1' | ā | ā |
application_tracking_enabledboolean | Application Tracking Permission | A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use 0 for disabled, 1 for enabled. ` | '0' or '1' | ā | ā |
extinfoobject | Extended Device Information | Extended device information, such as screen width and height. This parameter is an array and values are separated by commas. When using extinfo, all values are required and must be in the order indexed below. If a value is missing, fill with an empty string as a placeholder. | ā | ā |
Extended Device Information Keys
When using extinfo, all values are required and must be in the order indexed below. If a value is missing, fill with an empty string as a placeholder.
| Property | Definition | Description | Usage | Web | Mobile |
|---|---|---|---|---|---|
0string | Extinfo version | Note: version must be a2 for Android version must be i2 for iOS Required when using Mobile events | 'i2' | ā | ā |
1string | App package name | 'com.facebook.sdk.samples.hellofacebook' | ā | ā | |
2string | Short version | '1.0' | ā | ā | |
3string | Long version | '1.0 long' | ā | ā | |
4string | OS version | Required when using Mobile events | '13.4.1' | ā | ā |
5string | Device model name | 'iPhone5,1' | ā | ā | |
6string | Locale | 'En_US' | ā | ā | |
7string | Timezone abbreviation | 'PDT' | ā | ā | |
8string | Carrier | 'AT&T' | ā | ā | |
9string | Screen width | '320' | ā | ā | |
10string | Screen height | '568' | ā | ā | |
11string | Screen density | '2' | ā | ā | |
12string | CPU cores | '2' | ā | ā | |
13string | External storage size in GB | '13' | ā | ā | |
14string | Free space on external storage in GB | '8' | ā | ā | |
15string | Device timezone | 'USA/New York' | ā | ā |
Updated 12 months ago