Pinterest Conversions API

Pinterest Conversions API

Send event data to Pinterest Conversions API

The configuration process for this destination mirrors Segment's setup. We've automatically modified the documentation from third-party sources to show you how to set up this destination with PostHog.

The Pinterest Conversions API destination is a server-to-server integration with the Pinterest API for Conversions. 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 provides a more complete view of campaign performance.

Installation

Before connecting to the Pinterest Conversions destination, you must have a Pinterest account and an Ad Account ID.

To connect the Pinterest Conversions API Destination:

  1. From the PostHog web app, go to Data pipelines.
  2. Search for Pinterest Conversions API in the Destinations Data pipelines 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 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.

info "Setting conversion type" By default, PostHog 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.

Configuration

OptionDescription
Ad Account ID
Type: string
Required: True

Unique identifier of an ad account. This can be found in the Pinterest UI by following the steps mentioned here.

Conversion Token
Type: string
Required: True

The conversion token for your Pinterest account. This can be found in the Pinterest UI by following the steps mentioned here.

Debug Mode
Type: boolean
Required: False

Will log configuration and request details

Using our REST API you can create this destination like so:

Terminal
# Create a new destination
curl --location 'https://us.i.posthog.com/api/environments/:project_id/hog_functions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <POSTHOG_PERSONAL_API_KEY>' \
--data '{
"type": "destination",
"name": "Pinterest Conversions API",
"inputs": {
"ad_account_id": {
"value": ""
},
"conversion_token": {
"value": ""
}
},
"enabled": true,
"template_id": "segment-actions-pinterest-conversions-api"
}'

FAQ

Is the source code for this destination available?

Yes. The source code is available on GitHub.

Who maintains this?

This is maintained by Segment. If you have issues with it not functioning as intended, please let us know!

What if I have feedback on this destination?

We love feature requests and feedback. Please tell us what you think.

What if my question isn't answered above?

We love answering questions. Ask us anything via our community forum.

Parts of this page are sourced from segmentio/segment-docs under the Creative Commons Attribution 4.0 International License. The content may have been modified according to this code.