Pinterest conversion API

Author
Stape
Published
Jul 22, 2022
Also available in

Pinterest recently released a beta version of Pinterest Conversion API. Implementing Pinterest CAPI is an excellent way to increase the accuracy of conversion tracking and, as a result, get a better return on investment for paid advertising.

This blog post will explain the possibilities of Pinterest CAPI and how stape Pinterest conversion API tag for server GTM works. Click this link to read Pinterest CAPI documentation.

Pinterest conversion APICopy link to this section

1. Pinterest recommends using both browser and server tracking.

2. Supports event deduplication. To deduplicate matching events sent from web and server, Pinterest uses event ID.

3. Pinterest CAPI supports standard and custom events. The list of standard events:

  • add_to_cart
  • checkout
  • lead
  • page_visit
  • search
  • signup
  • view_category
  • watch_video

4. Pinterest CAPI supports real-time server event testing. When you add ?test=true, events are marked as tests; they will not be recorded.

5. Like FB CAPI, Pinterest asks to send user data in a lowercase hashed format. These are user data that Pinterest supports:

  • email addresses
  • phone numbers
  • gender
  • date of birthday
  • last name
  • first name
  • city
  • state
  • zip code
  • country ISO-3166
  • IP address
  • User-agent


6. Pinterest CAPI does not require Access Token. You should use only Pinterest advertiser ID.

7. Together with the event, you can send event and product data 

  • Contents. JSON object that contains product data, it may be item_price and quantity
  • Currency ISO-4217 standard
  • value
  • products IDs
  • Num_items. The total number of products in the event.
  • order_id

How does the Pinterest conversion API tag for server GTM work?Copy link to this section

The logic of stape’s Pinterest CAPI tag is similar to Facebook CAPI or TikTok events API tag. If you already have experience setting up these two, then Pinterest CAPI will be pretty straightforward. 

Event Name Setup Method - select from a list of standard events, add a custom event, or choose to Inherit an event name from a client. When Inherit from client is selected, the Pinterest CAPI tag will try to map events automatically into standard events or use a custom name if it’s impossible to map into a starred event. 

Pinterest Advertiser ID - You can find it by logging into the Pinterest account that owns your advertiser account, then going to "ads.pinterest.com." In the top navigation section, click "Viewing: " and the advertiser id will be the number underneath the ad account name in the drop-down menu. If your Pinterest account has multiple ad accounts, make sure you are choosing the proper one that you want to use for owning your API conversion events. Another way to confirm your advertiser id is to navigate to Ads > Overview and look for the id in the URL path. It will look like: "ads.pinterest.com/advertiser/ADVERTISER_ID/?...".

Test request - The events will not be recorded, but the API will still return the same response messages. Use this mode to verify your requests are working and that your events are constructed correctly.

Server Event Data Override - select from a list of custom data. 

User Data - select from a list of user data. 

Custom Data - select from a list of product data. 

Logs Settings - choose if you want to log requests to your stape account. This feature is handy when setting up server-side tagging since it allows seeing incoming and outgoing requests and network responses.  

Frequently asked questions:Copy link to this section

1. How can I add an event ID:

Event_id automatically grabbed from event data https://github.com/stape-io/pinterest-tag/blob/master/template.js#L321 , Or you can redefine it in tag settings.

Pinterest CAPI event ID

Need help with setting up server-side tagging?

All it takes is a few simple questions. Click Get A Quote, fill-up the form, and we will send you a quote.

Get a Quote
Tagged with:gtm server

Relevant posts

Feb 11, 2021

How to Setup Facebook Conversion API + Events Deduplication & Hash User Data

Facebook Pixel allows you to track what users are doing on your site, collect remarketing audiences and create lookalikes. If the Facebook pixel is implemented correctly, it will feed relevant information to FB machine learning algorithms. FB ML will use pixel data to show your ads to people who are most likely to convert. For several years now, we could track events on the site via javascript code, Facebook SDK inside apps, or upload offline events. But how can you track users who installed Ad Blocker or track events outside the site? Or how can you extend a cookie lifetime? It can be done by implementing Facebook conversion API. This article will show you how to set up Facebook conversion API via Google Tag Manager Server Container.

Oct 6, 2020

How to add a custom domain to the Google Tag Manager Server container

In this article, I will describe how to set up a custom subdomain within your Google Tag Manager server container. The main advantage of a custom subdomain inside the Google Tag Manager Server container is that it helps to bypass Intelligent Tracking Preventions, AdBlockers and increases cookie lifetime for users browsing in Safari. Pixels will be loaded from your subdomain and run as the first-party.

Oct 4, 2020

How to set up Google Tag Manager Server Container

Collecting data about your website visitors is critical for analyzing and improving the online business presence, reaching users, and converting them into customers. However, collecting data is becoming more problematic because of Intelligent Tracking Prevention, AdBlockers, and a decrease in cookie lifetime. Google Analytics and other similar tools will start seeing fewer data about your website visitors and giving you less information to analyze.

Host your GTM server at Staperight now!