Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Pinterest: Setup guide

On this page

This guide explains how to collect data from Pinterest.

Introduction

For a list of the fields that you can collect from Pinterest, see Pinterest.

Limitations

Collecting data from Pinterest comes with the following limitations:

  • The availability of historical data depends on the report granularity:

    • For non-hourly granularity, you can fetch data from up to 914 days before the current date. The maximum date range per request is 186 days.

    • For hourly granularity, you can fetch data from up to 8 days before the current date. The maximum date range per request is 3 days.

    • For product-level (PRODUCT_ITEM) reports, you can fetch data from up to 92 days before the current date. The maximum date range per request is 31 days.

Prerequisites

Before you start collecting data from Pinterest, perform all of the following actions:

  • To access Order lines data, you need Admin or Finance level permissions for the selected advertiser account.

Creating a datastream to collect data from Pinterest

The basics of creating a datastream to collect data from any data source are explained in our guide to Collecting data in Adverity. This guide contains information about the specific steps to create a datastream to fetch data from Pinterest.

Configuration: Choose the data you want to collect from Pinterest

To choose what data to collect and customize the Pinterest datastream configuration, follow these steps:

  1. (Optional) Rename your datastream.

  2. In Report type, select the type of data to collect from Pinterest. The fields you need to configure in the following steps differ according to the report type you select.

  3. Deselect the Include the user account that holds the authorization checkbox to select the advertisers for which to collect data.

  4. In Advertisers, select the advertisers for which to collect data.

  5. Select the Include my own pins checkbox to additionally collect data on your own pins.

  6. In Level, select the type of data to collect from Pinterest. The configuration options below may change depending on the selected level.

  7. In Targeting types, select the targeting types for which you want to collect data.

  8. In Statuses, select the statuses on which to collect data. If you do not select any items in a drop-down list, Adverity collects data for all items in the drop-down list.

  9. In Conversion time, select which date you want to include in your data extract. Select Ad Action to report on the date the user interacted with the ad or Conversion to report on the date the user completed a conversion event.

  10. In Fields, change the list of fields that you want to see in your data extract. The list of available fields may vary depending on the report type.

  11. Configure conversion data in Metadata fields, Clicks attribution window, Engagements attribution window, and Views attribution windows. For more information, see the Pinterest documentation.

  12. Select the Include lifetime metrics checkbox to additionally collect the following metrics:

    lifetime_metrics.pin_click
    lifetime_metrics.impression
    lifetime_metrics.clickthrough
    lifetime_metrics.reaction
    lifetime_metrics.comment
    
  13. In Number of pins, enter the number of top pins to collect. You can collect data on up to 50 top pins.

  14. In Sort by metric, select the metric to use for sorting the collected data.

  15. In Pin format, select the format of the pin.

  16. In App type, select user devices for which to collect data.

  17. In Granularity, select the time unit in which you want to retrieve your data.

  18. Select the Include sub categories checkbox to collect data for the sub categories of the categories selected in Fields.

  19. In Audience insight type, select an audience type for which to collect data.

  20. Select the Include incomplete rows checkbox to collect data rows that contain metrics in the processing state.

Troubleshooting

Invalid parameters when fetching data from Pinterest

An error message beginning with Invalid parameters appears because the selected start date for your fetch is more than 914 days ago.

To resolve this issue, change the start date for your fetch to a date within the past 914 days.

Last 90 days error message

The You can only get data from the last 90 days error message appears because you are trying to fetch data for a date range over 90 days for a report with a date range limitation.

To resolve this issue, fetch data for a date range shorter than 90 days.

Date range errors

If you encounter errors related to date ranges, consider the following:

  • Non-hourly request must be within 914 recent days: This error occurs when a non-hourly data request specifies a date range older than 914 days. Adjust your date range to be within the last 914 days.

  • HOURLY request must be less than 3 days: This error occurs when an hourly data request covers a period longer than 3 days. Reduce your date range to 3 days or less for hourly granularity.

  • Item-level time range error: This error indicates that an item-level data request (e.g., for product items) exceeds its supported date span (e.g., more than 31 days). Adjust the date range accordingly.

For all date range errors:

  1. Verify that your requested date range falls within the endpoint’s limitations.

  2. Check that you’re using the correct granularity level for extended historical data.

  3. Ensure your date format matches Pinterest’s API requirements.

Missing pin media

If pin preview images are not appearing:

  1. Confirm that pin_media field is included in your field selection.

  2. Verify that the extracted URL format is correct for your dashboard display requirements.

  3. Test the generated URLs manually to ensure they’re accessible.

Bad Request [Status 400] for Marketing Mix Modeling reports

A Bad request. [Status 400] error when fetching data for Marketing Mix Modeling reports can occur if some ad accounts within your configuration are unauthorized.

To resolve this issue:

  1. Ensure all selected ad accounts in your Pinterest datastream configuration are properly authorized.

If data is still fetched with warnings for unauthorized ad accounts, this is expected behavior to ensure the overall extraction job does not fail. Check the issues tab for specific warnings regarding unauthorized accounts.

What’s next?

Advanced Pinterest tips

Previewing an image

To be able to preview an image, you need to collect pin_media dimension.

To extract the image URL from this dimension, apply the following transformation to your data extract:

  1. Instruction 1

    Instruction

    convertx

    Field

    pin_media

    Python Expression

    {pin_media}.replace('{','').replace('\'','').replace(',','')

    Fail on error

    Selected

  2. Instruction 2

    Instruction

    convertx

    Field

    pin_media

    Python Expression

    {pin_media}.split('url:')[1] if len({pin_media}.split('url:'))>0 else ''

  3. Instruction 3

    Instruction

    convertx

    Field

    pin_media

    Python Expression

    {pin_media}.split(' ')[1] if len({pin_media}.split(' '))>0 else ''

Make sure to include all three instructions in one transformation.