Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Pinterest Conversions API


The Pinterest Conversions API destination is a server-to-server integration with the Pinterest API for Conversions(link takes you to an external page). This destination allows advertisers to send conversion events directly to Pinterest without needing a Pinterest tag. These conversions map to Pinterest campaigns for more accurate conversion reporting and improved visibility.

Advertisers can send web, in-app, or offline conversions to Pinterest's server in real time. Events received within an hour of occurring are reported as web or app events. Events received later, including batch-delayed events, are categorized as offline conversions.

Using the Pinterest API for conversions alongside the Pinterest tag(link takes you to an external page) provides a more complete view of campaign performance.


Benefits of Pinterest Conversions API (Actions)

benefits-of-pinterest-conversions-api-actions page anchor

The Pinterest Conversions API destination provides the following benefits:

  • Simplified setup. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings.
  • Clearer data mapping. Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to the Pinterest Conversions API.
  • Prebuilt event mappings. Standard events like Add to Cart come preconfigured with recommended parameters.
  • Deduplication support. Prevents duplicate events and improving conversion accuracy.
  • Page call support. You can send Page calls to Pinterest as a standard Page View.
  • Multi-user array support. User data nested within arrays, like the User Data array in the Order Completed event, can be sent to Pinterest.
  • Data normalization. Data is normalized before it's hashed to send to Pinterest Conversions.

Before connecting to the Pinterest Conversions destination, you must have a Pinterest(link takes you to an external page) account and an Ad Account ID.

To connect the Pinterest Conversions API Destination:

  1. From the Segment web app, go to Connections > Catalog.
  2. Search for Pinterest Conversions API in the Destinations Catalog and select the destination.
  3. Click Configure Pinterest Conversions API.
  4. Select the source that will send data to Pinterest Conversions API and follow the prompts to name your destination.
  5. On the Basic Settings page, enter:
  6. Go to the Mappings tab. Prebuilt mappings, like Checkout, Search, and Add to Cart, include predefined parameters. All required, recommended, and optional fields are listed in Pinterest's Best practices(link takes you to an external page) documentation.
  7. To create a new mapping:
    • Click New Mapping and select Report Conversions Event.
    • Configure and enable the mapping.
  8. Follow the steps in Customizing mappings.
  9. Toggle Enable Destination on, then click Save Changes.

Property nameTypeRequiredDescription
Ad Account IDstring
required

Unique identifier of an ad account. This can be found in the Pinterest UI by following the steps mentioned here(link takes you to an external page).


Conversion Tokenpassword
required

The conversion token for your Pinterest account. This can be found in the Pinterest UI by following the steps mentioned here(link takes you to an external page).


Pinterest Conversions API has the following presets

Preset NameTriggerDefault Action
SearchEvent type = "track" AND event = "Products Searched"Report Conversion Event
Add to CartEvent type = "track" AND event = "Product Added"Report Conversion Event
Page VisitEvent type = "page"Report Conversion Event
Watch VideoEvent type = "track" AND event = "Product Video Watched"Report Conversion Event
LeadEvent type = "track" AND event = "Generate Lead"Report Conversion Event
CheckoutEvent type = "track" AND event = "Checkout"Report Conversion Event
View CategoryEvent type = "track" AND event = "Product Category Viewed"Report Conversion Event
Sign UpEvent type = "track" AND event = "Signed Up"Report Conversion Event

Build your own Mappings. Combine supported triggers with the following Pinterest Conversions API-supported actions:

(information)

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Report Conversion Event

report-conversion-event page anchor

Report events directly to Pinterest. Data shared can power Pinterest solutions that will help evaluate ads effectiveness and improve content, targeting, and placement of future ads.

Report Conversion Event is a Cloud action.

Property nameTypeRequiredDescription
Event NameSTRING
required

The conversion event type. For custom events, you must use the predefined event name "custom". Please refer to the possible event types in Pinterest API docs(link takes you to an external page).


Action SourceSTRING
required

The source indicating where the conversion event occurred. This must be app_android, app_ios , web or offline.


Event TimestampSTRING
required

Device IDs can be used to add and remove only anonymous users to/from a cohort. However, users with an assigned User ID cannot use Device ID to sync to a cohort.


Event IDSTRING
required

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.


Event Source URLSTRING

Optional

URL of the web conversion event.


Opt OutBOOLEAN

Optional

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.


User DataOBJECT

Optional

Object containing customer information data. Note, It is required at least one of 1) em, 2) hashed_maids or 3) pair client_ip_address + client_user_agent..


Custom DataOBJECT

Optional

Object containing customer information data.


App IDSTRING

Optional

The app store app ID.


App NameSTRING
required

Name of the app.


App VersionSTRING

Optional

Version of the app.


Device BrandSTRING

Optional

Brand of the user device.


Device CarrierSTRING

Optional

User device’s mobile carrier.


Device ModelSTRING

Optional

Model of the user device.


Device TypeSTRING

Optional

Type of the user device.


OS VersionSTRING

Optional

Version of the device operating system.


WifiBOOLEAN

Optional

Whether the event occurred when the user device was connected to wifi.


LanguageSTRING

Optional

Two-character ISO-639-1 language code indicating the user's language.

(information)

Setting conversion type

By default, Segment sends all mappings as web conversions. To send events as mobile or offline conversions, set the Action Source in each mapping to app_android, app_ios, or offline.


Deduplication with the Pinterest tag

deduplication-with-the-pinterest-tag page anchor

When the Pinterest tag and the API for conversions both report the same event, Pinterest can't automatically determine if they're duplicates. Because Pinterest recommends using both methods together, deduplication is essential to prevent double-counting.

If an event is sent from both the Pinterest tag and the API using the same event_id, Pinterest treats them as a single event. This prevents conversions from being counted twice and improves attribution accuracy.

For example:

  1. A user adds an item to their cart.
  2. The Pinterest tag reports the event with event_id: 123.
  3. Later, the web server also sends the event to the API with event_id: 123.
  4. When Pinterest receives both events, Segment checks the event_id to confirm they refer to the same action.

By using deduplication, advertisers can report conversions through both methods without inflating conversion counts. If an event is only received from one source, Pinterest still attributes it appropriately.

Conversion events must meet the following requirements to be considered for deduplication:

  • The event includes a non-empty, non-null event_id and event_name.
  • The action_source is not offline (for example, it occurred in-app or on the web). Supported values include app_android, app_ios, and web.
  • The duplicate events arrive within 24 hours of the first recorded event.
(information)

Info

Segment offers a client-side destination for the Pinterest tag. See the Pinterest destination documentation for setup instructions and implementation details.

Events fail to send due to missing App Name

events-fail-to-send-due-to-missing-app-name page anchor

The App Name field is required for many Pinterest Conversion API destination's mappings.

Segment's mobile libraries automatically collect and map the App Name to the correct field. However, Segment's web or server-based libraries don't automatically collect and map App Name, which can cause mappings to fail. Segment recommends adding the App Name to the Segment event or hardcoding a static string in the mapping as the App Name.


On January 1, 2023, Pinterest introduced the Limited Data Processing (LDP) flag(link takes you to an external page) to help advertisers comply with the California Consumer Privacy Act (CCPA).

Advertisers are responsible for complying with user opt-outs, as well as identifying the user's state of residency when implementing the Limited Data Processing flag.

Enabling LDP could impact campaign performance and targeting capabilities. Pinterest recommends applying the LDP flag on a per-user basis for the best results.

LDP is enabled only if all three required fields in the following table are present. If any field is missing, LDP is ignored.

Field NameField DescriptionRequired Value for LDP
opt_out_typeOpt out Type based on user's privacy preference"LDP"
stState of residence"CA"
countryCountry of residence"US"

Before sending data to Pinterest, Segment applies SHA-256 hashing to the following personally identifiable information (PII) fields:

  • User identifiers: external ID, mobile ad identifier
  • Contact information: email, phone
  • Demographics: gender, date of birth
  • Name details: first name, last name
  • Location: city, state, ZIP code, country

Segment automatically maps User Data fields to their corresponding parameters as expected by the Conversions API(link takes you to an external page) before sending to Pinterest Conversions:

User Data FieldConversions API User Data Parameter
External IDexternal_id
Mobile Ad Idhashed_maids
Client IP Addressclient_ip_address
Client User Agentclient_user_agent
Emailem
Phoneph
Genderge
Date of Birthdb
Last Nameln
First Namefn
Cityct
Statest
Zip Codezp
Countrycountry

Segment automatically maps Custom Data fields (excluding content_ids, contents, num_items, opt_out_type) to their corresponding parameters as expected by the Conversions API(link takes you to an external page) before sending to Pinterest Conversions:

User Data FieldConversions API Custom Data Parameter
Currencycurrency
Valuevalue
Content IDscontent_ids
Contentscontents
Number of itemsnum_items
Order IDorder_id
Search stringsearch_string
Opt out typeopt_out_type

Server event parameter requirements

server-event-parameter-requirements page anchor

Pinterest requires the action_source server event parameter for all events sent to the Pinterest Conversions API. This parameter specifies where the conversions occur.

Verify events in Pinterest Conversions dashboard

verify-events-in-pinterest-conversions-dashboard page anchor

After you start sending events, you should start seeing them in dashboard. You can confirm that Pinterest received them by following these steps:

  1. Go to Events Overview in Pinterest.
  2. Click Event History to see all the events Segment sent to Pinterest conversions.

Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Ad Account IDstring
required

Unique identifier of an ad account. This can be found in the Pinterest UI by following the steps mentioned here(link takes you to an external page).


Conversion Tokenpassword
required

The conversion token for your Pinterest account. This can be found in the Pinterest UI by following the steps mentioned here(link takes you to an external page).