Pinterest Ads Reference

Send advertising events directly to Pinterest Ads

Destination Info

Client-sideServer-side

Web

Mobile

Server

This is a reference document for the Pinterest Ads destination. For information on how to set up this integration, see the Pinterest Ads Quick Start Guide.

Events

When you send an event (with a valid event name) to the Pinterest Ads destination from Freshpaint, Freshpaint will create an event in the Pinterest Ads conversion manager by sending requests to the Pinterests conversion API.

Track Events

When you send an event to the Pinterest Ads destination, you can track conversions from your ads based on those events.

Below are the Required, Recommended, and Optional properties which are mapped to the Pinterest Ads request:

Valid Event Names

The event name must be one of the below events, matching symbols, case, and whitespace.

  • add_to_cart

  • checkout

  • custom

  • lead

  • page_visit

  • search

  • signup

  • view_category

  • watch_video

Valid Action Sources

By default if no action source is provided we will assume web, otherwise one of the below sources must be sent:

  • app_android

  • app_ios

  • web

  • offline

Property Table

The following event properties are required in order to attribute events to specific ads, and if in HIPAA mode, must be selected in the Required Properties Allow List.

Freshpaint property

Pinterest Ads parameter

Type

Requirement

Description

$epik

epik

string

Required

The unique identifier stored in the _epik cookie on your domain or &epik= query parameter in the URL. This acts as the click ID.

ad_account_id

ad_account_id

string

Required

The ad account associated with this conversion event

$event_name

event_name

string

Required

The event name sent to Pinterest. This must be a valid event name as listed here.

action_source

action_source

string

Recommended

The source of the event. This must be a valid source as listed here.

Last updated