jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-20 10:32:35 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
yarden/source-mongodb-support-dynamic-arrays
airbyte/docs/integrations/sources/pinterest.md
octavia-bot-hoard[bot] 6d8c361032 🐙 source-pinterest: run up-to-date pipeline [2025-10-29] (#68961) 
Co-authored-by: octavia-bot-hoard[bot] <230633153+octavia-bot-hoard[bot]@users.noreply.github.com>
2025-10-28 22:44:50 -04:00

60 KiB
Raw Permalink Blame History

Pinterest

This page contains the setup guide and reference information for the Pinterest source connector.

Prerequisites

When setting up the Pinterest source connector with Airbyte Cloud, be aware that Pinterest does not allow configuring permissions during the OAuth authentication process. Therefore, the following permissions will be requested during authentication:

  • See all of your advertising data, including ads, ad groups, campaigns, etc.
  • See your public boards, including group boards you join.
  • See your secret boards.
  • See all of your catalogs data.
  • See your public Pins.
  • See your secret Pins.
  • See your user accounts and followers.

For more information on the scopes required for Pinterest OAuth, please refer to the Pinterest API Scopes documentation.

To set up the Pinterest source connector with Airbyte Open Source, you'll need your Pinterest App ID and secret key and the refresh token.

Setup guide

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Pinterest from the Source type dropdown.
  4. Enter the name for the Pinterest connector.
  5. For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. As per Pinterest API restriction, the date cannot be more than 90 days in the past.
  6. The OAuth2.0 authorization method is selected by default. Click Authenticate your Pinterest account. Log in and authorize your Pinterest account.
  7. (Optional) Enter a Start Date using the provided date picker, or by manually entering the date in YYYY-MM-DD format. Data added on and after this date will be replicated. If no date is set, it will default to the latest allowed date by the report API (913 days from today).
  8. (Optional) Select one or multiple status values from the dropdown menu. For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
  9. (Optional) Add custom reports if needed. For more information, refer to the corresponding section.
  10. (Optional) Enter an Ad Account ID. If specified, the source will only retrieve data for that specific Pinterest Ad Account.
  11. Click Set up source.

For Airbyte Open Source:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Pinterest from the Source type dropdown.
  4. Enter the name for the Pinterest connector.
  5. For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. As per Pinterest API restriction, the date cannot be more than 90 days in the past.
  6. The OAuth2.0 authorization method is selected by default. For Client ID and Client Secret, enter your Pinterest App ID and secret key. For Refresh Token, enter your Pinterest Refresh Token.
  7. (Optional) Enter a Start Date using the provided date picker, or by manually entering the date in YYYY-MM-DD format. Data added on and after this date will be replicated. If no date is set, it will default to the latest allowed date by the report API (913 days from today).
  8. (Optional) Select one or multiple status values from the dropdown menu. For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
  9. (Optional) Add custom reports if needed. For more information, refer to the corresponding section.
  10. (Optional) Enter an Ad Account ID. If specified, the source will only retrieve data for that specific Pinterest Ad Account.
  11. Click Set up source.

Supported sync modes

The Pinterest source connector supports the following sync modes:

Supported Streams

Custom reports

Custom reports in the Pinterest connector allow you to create personalized analytics reports for your account. You can tailor these reports to your specific needs by choosing from various properties:

  1. Name: A unique identifier for the report.
  2. Level: Specifies the data aggregation level, with options like ADVERTISER, CAMPAIGN, AD_GROUP, etc. The default level is ADVERTISER.
  3. Granularity: Determines the data granularity, such as TOTAL, DAY, HOUR, etc. The default is TOTAL, where metrics are aggregated over the specified date range.
  4. Columns: Identifies the data columns to be included in the report.
  5. Click Window Days (Optional): The number of days used for conversion attribution from a pin click action. This applies to Pinterest Tag conversion metrics. Defaults to 30 days if not specified.
  6. Engagement Window Days (Optional): The number of days used for conversion attribution from an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. This applies to Pinterest Tag conversion metrics. Defaults to 30 days if not specified.
  7. View Window Days (Optional): The number of days used as the conversion attribution window for a view action. This applies to Pinterest Tag conversion metrics. Defaults to 1 day if not specified.
  8. Conversion Report Time (Optional): Indicates the date by which the conversion metrics returned will be reported. There are two dates associated with a conversion event: the date of ad interaction and the date of conversion event completion. The default is TIME_OF_AD_ACTION.
  9. Attribution Types (Optional): Lists the types of attribution for the report, such as INDIVIDUAL or HOUSEHOLD.
  10. Start Date (Optional): The start date for the report in YYYY-MM-DD format, defaulting to the latest allowed date by the report API (913 days from today).

For more detailed information and guidelines on creating custom reports, please refer to the Pinterest API documentation.

Performance considerations

The connector is restricted by the Pinterest requests limitation.

Changelog

Expand to review
Version Date Pull Request Subject
2.1.17 2025-10-29 68961 Update dependencies
2.1.16 2025-10-21 68213 Update dependencies
2.1.15 2025-10-14 67808 Update dependencies
2.1.14 2025-10-07 62329 Update dependencies
2.1.13 2025-10-06 67105 Promoting release candidate 2.1.13-rc.2 to a main version.
2.1.13-rc.2 2025-10-03 67025 Add timeout status for reports
2.1.13-rc.1 2025-09-30 66755 Migrate to manifest-only
2.1.12 2025-09-30 66820 Promoting release candidate 2.1.12-rc.1 to a main version.
2.1.12-rc.1 2025-09-29 66564 Migrate Custom Reports streams
2.1.11 2025-09-29 66737 Promoting release candidate 2.1.11-rc.1 to a main version.
2.1.11-rc.1 2025-09-23 66560 Migrate Targeting Analytics Reports streams
2.1.10 2025-09-22 66565 Promoting release candidate 2.1.10-rc.1 to a main version.
2.1.10-rc.1 2025-09-16 66187 Migrate Analytics Reports streams
2.1.9 2025-09-16 66281 Promoting release candidate 2.1.9-rc.2 to a main version.
2.1.9-rc.2 2025-09-12 66211 Add APIBudget and backoff strategy for analytics streams
2.1.9-rc.1 2025-09-05 65960 feat(source-pinterest): Update CDK to v6
2.1.8 2025-06-21 61920 Update dependencies
2.1.7 2025-06-14 61067 Update dependencies
2.1.6 2025-05-24 60136 Update dependencies
2.1.5 2025-05-04 59069 Update dependencies
2.1.4 2025-04-19 58524 Update dependencies
2.1.3 2025-04-12 57926 Update dependencies
2.1.2 2025-04-05 57337 Update dependencies
2.1.1 2025-03-29 56721 Update dependencies
2.1.0 2025-02-03 53135 Added Account Id filter to allow retrieving data for a specific ad account
2.0.32 2025-03-22 55055 Update dependencies
2.0.31 2025-02-23 54581 Update dependencies
2.0.30 2025-02-15 53977 Update dependencies
2.0.29 2025-02-01 53001 Update dependencies
2.0.28 2025-01-25 52502 Update dependencies
2.0.27 2025-01-11 51377 Update dependencies
2.0.26 2025-01-04 50933 Update dependencies
2.0.25 2024-12-28 50710 Update dependencies
2.0.24 2024-12-21 50302 Update dependencies
2.0.23 2024-12-14 49040 Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
2.0.22 2024-11-04 48280 Update dependencies
2.0.21 2024-10-29 47074 Update dependencies
2.0.20 2024-10-12 46815 Update dependencies
2.0.19 2024-10-05 46482 Update dependencies
2.0.18 2024-09-28 46104 Update dependencies
2.0.17 2024-09-21 45838 Update dependencies
2.0.16 2024-09-14 45566 Update dependencies
2.0.15 2024-09-07 45283 Update dependencies
2.0.14 2024-08-31 45060 Update dependencies
2.0.13 2024-08-24 44752 Update dependencies
2.0.12 2024-08-17 44346 Update dependencies
2.0.11 2024-08-12 43838 Update dependencies
2.0.10 2024-08-10 43642 Update dependencies
2.0.9 2024-08-03 43280 Update dependencies
2.0.8 2024-07-30 39559 Ensure config_error when state has improper format and update CDK version
2.0.7 2024-07-27 42603 Update dependencies
2.0.6 2024-07-20 42343 Update dependencies
2.0.5 2024-07-13 41765 Update dependencies
2.0.4 2024-07-10 41449 Update dependencies
2.0.3 2024-07-06 39972 Update dependencies
2.0.2 2024-06-10 39367 Fix type error when start date was not provided
2.0.1 2024-06-04 39037 [autopull] Upgrade base image to v1.2.1
2.0.0 2024-05-20 37698 Migrate to low-code
1.3.3 2024-04-24 36655 Schema descriptions and CDK 0.80.0
1.3.2 2024-04-08 36912 Fix icon
1.3.1 2024-04-03 36806 Update airbyte-cdk count bug to emit recordCount as float
1.3.0 2024-03-19 36267 Pin airbyte-cdk version to ^0
1.2.0 2024-02-20 35465 Per-error reporting and continue sync on stream failures
1.1.1 2024-02-12 35159 Manage dependencies with Poetry.
1.1.0 2023-11-22 32747 Update docs and spec. Add missing placement_traffic_type field to AdGroups stream
1.0.0 2023-11-16 32595 Add airbyte_type: timestamp_without_timezone to date-time fields across all streams. Rename Advertizer* streams to Advertiser*
0.8.2 2023-11-20 32672 Fix backoff waiting time
0.8.1 2023-11-16 32601 added ability to create custom reports
0.8.0 2023-11-16 32592 Make start_date optional; add suggested streams; add missing fields
0.7.2 2023-11-08 32299 added default AvailabilityStrategy, fixed bug which cases duplicated requests, added new streams: Catalogs, CatalogsFeeds, CatalogsProductGroups, Audiences, Keywords, ConversionTags, CustomerLists, CampaignTargetingReport, AdvertizerReport, AdvertizerTargetingReport, AdGroupReport, AdGroupTargetingReport, PinPromotionReport, PinPromotionTargetingReport, ProductGroupReport, ProductGroupTargetingReport, ProductItemReport, KeywordReport
0.7.1 2023-11-01 32078 handle non json response
0.7.0 2023-10-25 31876 Migrated to base image, removed token based authentication mthod becuase access_token is valid for 1 day only
0.6.0 2023-07-25 28672 Add report stream for CAMPAIGN level
0.5.3 2023-07-05 27964 Add id field to owner field in ad_accounts stream
0.5.2 2023-06-02 26949 Update BoardPins stream with note property
0.5.1 2023-05-11 25984 Add pattern for start_date
0.5.0 2023-05-17 26188 Add product_tags field to the BoardPins stream
0.4.0 2023-05-16 26112 Add is_standard field to the BoardPins stream
0.3.0 2023-05-09 25915 Add creative_type field to the BoardPins stream
0.2.6 2023-04-26 25548 Fix format issue for boards stream schema for fields with date-time
0.2.5 2023-04-19 0 Update AMOUNT_OF_DAYS_ALLOWED_FOR_LOOKUP to 89 days
0.2.4 2023-02-25 23457 Add missing columns for analytics streams for pinterest source
0.2.3 2023-03-01 23649 Fix for HTTP - 400 Bad Request when requesting data >= 90 days
0.2.2 2023-01-27 22020 Set AvailabilityStrategy for streams explicitly to None
0.2.1 2022-12-15 20532 Bump CDK version
0.2.0 2022-12-13 20242 Add data-type normalization up to the schemas declared
0.1.9 2022-09-06 15074 Add filter based on statuses
0.1.8 2022-10-21 18285 Fix type of start_date
0.1.7 2022-09-29 17387 Set start_date dynamically based on API restrictions.
0.1.6 2022-09-28 17304 Use CDK 0.1.89
0.1.5 2022-09-16 16799 Migrate to per-stream state
0.1.4 2022-09-06 16161 Add ability to handle 429 - Too Many Requests error with respect to Max Rate Limit Exceeded Error
0.1.3 2022-09-02 16271 Add support of OAuth2.0 authentication method
0.1.2 2021-12-22 10223 Fix naming of AD_ID and AD_ACCOUNT_ID fields
0.1.1 2021-12-22 9043 Update connector fields title/description
0.1.0 2021-10-29 7493 Release Pinterest CDK Connector
Reference in New Issue View Git Blame Copy Permalink