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:
- 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.
- (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).
- (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.
- (Optional) Add custom reports if needed. For more information, refer to the corresponding section.
- 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.
- (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).
- (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.
- (Optional) Add custom reports if needed. For more information, refer to the corresponding section.
- Click Set up source.
Supported sync modes
The Pinterest source connector supports the following sync modes:
Supported Streams
- Account analytics (Incremental)
- Boards (Full refresh)
- Board sections (Full refresh)
- Pins on board section (Full refresh)
- Pins on board (Full refresh)
- Ad accounts (Full refresh)
- Ad account analytics (Incremental)
- Campaigns (Incremental)
- Campaign analytics (Incremental)
- Campaign Analytics Report (Incremental)
- Campaign Targeting Report (Incremental)
- Ad Groups (Incremental)
- Ad Group Analytics (Incremental)
- Ad Group Report (Incremental)
- Ad Group Targeting Report (Incremental)
- Ads (Incremental)
- Ad analytics (Incremental)
- Catalogs (Full refresh)
- Catalogs Feeds (Full refresh)
- Catalogs Product Groups (Full refresh)
- Audiences (Full refresh)
- Keywords (Full refresh)
- Conversion Tags (Full refresh)
- Customer Lists (Full refresh)
- Advertizer Report (Incremental)
- Advertizer Targeting Report (Incremental)
- Pin Promotion Report (Incremental)
- Pin Promotion Targeting Report (Incremental)
- Product Group Report (Incremental)
- Product Group Targeting Report (Incremental)
- Product Item Report (Incremental)
- Keyword Report (Incremental)
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:
- Name: A unique identifier for the report.
- Level: Specifies the data aggregation level, with options like ADVERTISER, CAMPAIGN, AD_GROUP, etc. The default level is ADVERTISER.
- Granularity: Determines the data granularity, such as TOTAL, DAY, HOUR, etc. The default is TOTAL, where metrics are aggregated over the specified date range.
- Columns: Identifies the data columns to be included in the report.
- 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.
- 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.
- 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.
- 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.
- Attribution Types (Optional): Lists the types of attribution for the report, such as INDIVIDUAL or HOUSEHOLD.
- 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.