This page contains the setup guide and reference information for the Pinterest source connector.
Prerequisites
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:
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- On the Set up the source page, select Pinterest from the Source type dropdown.
- Enter the name for the Pinterest connector.
- 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.
- The OAuth2.0 authorization method is selected by default. Click Authenticate your Pinterest account. Log in and authorize your Pinterest account.
- Click Set up source.
For Airbyte Open Source:
- Navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Pinterest from the Source type dropdown.
- Enter the name for the Pinterest connector.
- 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.
- 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.
- Click Set up source.
Supported sync modes
The Pinterest source connector supports the following sync modes:
Supported Streams
- Account analytics (Incremental)
- Boards (Full table)
- Board sections (Full table)
- Pins on board section (Full table)
- Pins on board (Full table)
- Board sections (Full table)
- Ad accounts (Full table)
- Ad account analytics (Incremental)
- Campaigns (Incremental)
- Campaign analytics (Incremental)
- Campaign Analytics Report (Incremental)
- Ad groups (Incremental)
- Ad group analytics (Incremental)
- Ads (Incremental)
- Ad analytics (Incremental)
Performance considerations
The connector is restricted by the Pinterest requests limitation.
Rate Limits
- Analytics streams: 300 calls per day / per user \
- Ad accounts streams (Campaigns, Ad groups, Ads): 1000 calls per min / per user / per app \
- Boards streams: 10 calls per sec / per user / per app
Changelog
Version | Date | Pull Request | Subject |
---|---|---|---|
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 | 00000 | 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 |