| Name | Type | Description | Notes |
|---|---|---|---|
| event_name | str | The type of the user event. Please use the right event_name otherwise the event won’t be accepted and show up correctly in reports. <li><code>add_to_cart</code> <li><code>checkout</code> <li><code>custom</code> <li><code>lead</code> <li><code>page_visit</code> <li><code>search</code> <li><code>signup</code> <li><code>view_category</code> <li><code>watch_video</code> | |
| action_source | str | The source indicating where the conversion event occurred. <li><code>app_android</code> <li><code>app_ios</code> <li><code>web</code> <li><code>offline</code> | |
| event_time | int | The time when the event happened. Unix timestamp in seconds. | |
| event_id | str | A unique id string that identifies this event and can be used for deduping between events ingested via both the conversion API and Pinterest tracking. Without this, event's data is likely to be double counted and will cause report metric inflation. Third-party vendors make sure this field is updated on both Pinterest tag and Conversions API side before rolling out template for Conversions API. | |
| user_data | ConversionEventsUserData | ||
| event_source_url | str, none_type | URL of the web conversion event. | [optional] |
| opt_out | bool | When action_source is web or offline, it defines whether the user has opted out of tracking for web conversion events. While when action_source is app_android or app_ios, it defines whether the user has enabled Limit Ad Tracking on their iOS device, or opted out of Ads Personalization on their Android device. | [optional] |
| partner_name | str, none_type | The third party partner name responsible to send the event to Conversions API on behalf of the advertiser. The naming convention is "ss-partnername" lowercase. E.g ‘ss-shopify’ | [optional] |
| custom_data | ConversionEventsCustomData | [optional] | |
| app_id | str, none_type | The app store app ID. | [optional] |
| app_name | str, none_type | Name of the app. | [optional] |
| app_version | str, none_type | Version of the app. | [optional] |
| device_brand | str, none_type | Brand of the user device. | [optional] |
| device_carrier | str, none_type | User device's mobile carrier. | [optional] |
| device_model | str, none_type | Model of the user device. | [optional] |
| device_type | str, none_type | Type of the user device. | [optional] |
| os_version | str, none_type | Version of the device operating system. | [optional] |
| wifi | bool | Whether the event occurred when the user device was connected to wifi. | [optional] |
| language | str, none_type | Two-character ISO-639-1 language code indicating the user's language. | [optional] |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |