As a part of the upgrade of Pinterest API to v5 that planned for Wednesday June 28, 2023, there are several changes for existing common Pinterest reports:
-
The new Pinterest API v5 requires a different authorization flow, and the older authentication tokens won’t be valid after the v4 deprecation date. Starting June 28, 2023, you should re-authenticate by editing your existing Pinterest connections.
-
The upgrade includes deprecated and new columns as described below.
If you want to use the new fields / properties:
Update Rivery’s mapping of the relevant reports according to the required fields (using “clear all” and then “Auto Mapping” under your River schema tab).
If you are currently using deprecated fields:
If no action is taken, deprecated fields / properties will be shown as null in the existing report’s data. If you wish to remove those from the target table, remove those in the schema mapping.
Note: In ‘User Top Video Pin Metrics report’ - the existing ‘Sort By video Metric Type’ is required, please make sure you fill it by the desired type in your rivers.
Audiences report - deprecated
‘Advertisers’ report - renamed to ‘Ad Accounts’
Removed input in the UI - ‘Include ACL’
Added input in the UI - ‘Include shared ad accounts’
Deprecated columns in report result - ‘BUSINESS_ADDRESS_POSTAL_CODE’, ‘BILLING_PROFILE_STATUS’, ‘TYPE’, ‘MERCHANT_ID’, ‘ROLES’, ‘BUSINESS_ADDRESS_PHONE_NUMBER’, ‘BUSINESS_ADDRESS_ADDRESS_LINE_2’, ‘BUSINESS_ADDRESS_STREET_NUMBER’, ‘REPRESENTED_ADVERTISER_COUNTRY’, ‘ACCEPTED_TERMS’, ‘BUSINESS_ADDRESS_COUNTRY’, ‘STATUS’, ‘BUSINESS_ADDRESS_ADDRESS_LINE_1’, ‘OWNER_USER_ID’, ‘BUSINESS_ADDRESS_NEIGHBORHOOD’, ‘BUSINESS_ADDRESS_STATE’, ‘BUSINESS_ADDRESS_CITY’, ‘EXEMPT_ADDITIONAL_TAX’, ‘BILLING_TYPE’
New columns in report result - ‘PERMISSIONS’, ‘OWNER_USERNAME’
Audience per scope and type Report
Removed input in the UI- Include ACL, Scope, Type, Include Categories per Scope Type
Added input in the UI - Audience Insight Type
Deprecated columns in the report result - ‘SCOPE_TYPE_TARGET_TYPE’, ‘SCOPE_TYPE_SUB_CATEGORY_ID’, ‘SCOPE_TYPE_SUB_CATEGORY_NAME’, ‘SCOPE’, ‘SCOPE_TYPE_SUB_CATEGORY_INDEX’, ‘SCOPE_TYPE_TARGET_DATE’, ‘SCOPE_TYPE_SUB_CATEGORY_RATIO’, ‘SCOPE_TYPE_SUB_CATEGORY_KEY’, ‘SCOPE_TYPE_TARGET_SCOPE’
New columns in report result - ‘SCOPE_TYPE_TYPE’, ‘SCOPE_TYPE_DATE’, ‘SCOPE_TYPE_DEMOGRAPHICS_COUNTRIES’
Delivery Metrics Definitions Report
Deprecated columns in the report result - metrics
New columns in report result - name, category, definition, display_name
User Metrics Report
Removed inputs from the UI - ‘Paid/Unpaid metrics’, ‘In Profile’, ‘From Owned Content’, ‘Downstream Metrics’, ‘Publish Types.
Changes in ‘Metric Types’ input options- The current options are: “ENGAGEMENT”, “ENGAGEMENT_RATE”, “IMPRESSION”, “OUTBOUND_CLICK”, “OUTBOUND_CLICK_RATE”, “PIN_CLICK”, “PIN_CLICK_RATE”, “SAVE”, “SAVE_RATE”
User Top Pin Metrics Report
Removed inputs from the UI - paid, in_profile, from_owned_content, downstream, publish_types, Sort by metric type
Added input to the UI- Sort By
Deprecated columns in the report result - date_availability
New columns in report result - ‘date_availability_latest_available_timestamp’, ‘date_availability_is_realtime’, ‘pin_metrics_IMPRESSION’, ‘pin_metrics_OUTBOUND_CLICK’, ‘pin_metrics_PIN_CLICK’, ‘pin_metrics_PROFILE_VISIT’, ‘pin_metrics_QUARTILE_95_PERCENT_VIEW’, ‘pin_metrics_SAVE’, ‘pin_metrics_SAVE_RATE’, ‘pin_metrics_USER_FOLLOW’, ‘pin_metrics_VIDEO_10S_VIEW’, ‘pin_metrics_VIDEO_AVG_WATCH_TIME’, ‘pin_metrics_VIDEO_MRC_VIEW’, ‘pin_metrics_VIDEO_START’, ‘pin_metrics_VIDEO_V50_WATCH_TIME’, ‘pin_id’
User Top Video Pin Metrics Report
Removed inputs from the UI - paid, in_profile, from_owned_content, downstream, publish_types
Renamed fields -
video_metric_types → metric_types
sort_by_video_metrics → sort_by (Note: this input is required in the new version, please make sure you fill it by the desired type in your rivers).
Deprecated columns in the report result - date_availability
New columns in report result - ‘date_availability_latest_available_timestamp’, ‘date_availability_is_realtime’, ‘pin_metrics_IMPRESSION’, ‘pin_metrics_OUTBOUND_CLICK’, ‘pin_metrics_PIN_CLICK’, ‘pin_metrics_PROFILE_VISIT’, ‘pin_metrics_QUARTILE_95_PERCENT_VIEW’, ‘pin_metrics_SAVE’, ‘pin_metrics_SAVE_RATE’, ‘pin_metrics_USER_FOLLOW’, ‘pin_metrics_VIDEO_10S_VIEW’, ‘pin_metrics_VIDEO_AVG_WATCH_TIME’, ‘pin_metrics_VIDEO_MRC_VIEW’, ‘pin_metrics_VIDEO_START’, ‘pin_metrics_VIDEO_V50_WATCH_TIME’, ‘pin_id’
User information Report
Deprecated columns in the report result - ‘FIRST_NAME’, ‘SEO_TITLE’, ‘MESSAGING_PERMISSIONS_CONTACTS’, ‘IS_DEFAULT_IMAGE’, ‘SHOW_CREATOR_PROFILE’, ‘PINS_DONE_COUNT’, ‘DOMAIN_VERIFIED’, ‘GROUP_BOARD_COUNT’, ‘IMAGE_XLARGE_URL’, ‘SHOULD_DEFAULT_COMMENTS_OFF’, ‘IS_AGE_ELIGIBLE_FOR_LEAD_FORM_AUTOFILL’, ‘MESSAGING_PERMISSIONS_FOLLOWEES’, ‘IS_EMAIL_ELIGIBLE_FOR_LEAD_FORM_AUTOFILL’, ‘PROFILE_COVER_SOURCE_SOURCE_ID’, ‘DOMAIN_URL’, ‘CANONICAL_MERCHANT_DOMAIN’, ‘PARTNER_ID’, ‘IMAGE_MEDIUM_URL’, ‘MESSAGING_PERMISSIONS_FRIENDS’, ‘following’, ‘PROFILE_HIGHLIGHT_COUNT’, ‘SEO_NOINDEX_REASON’, ‘MESSAGING_PERMISSIONS_OTHERS’, ‘SHOULD_SHOW_CREATOR_BUBBLES’, ‘DOMINANT_COLOR_CSS’, ‘RECENT_PIN_IMAGES’, ‘SHOW_IMPRESSUM’, ‘RECOMMENDATION_REASON’, ‘IS_PARTNER’, ‘LIKE_COUNT’, ‘IS_LINKED_BUSINESS’, ‘TAG’, ‘IS_INSPIRATIONAL_MERCHANT’, ‘LISTED_WEBSITE_URL’, ‘STOREFRONT_SEARCH_VISIBLE’, ‘NATIVE_PIN_COUNT’, ‘IMAGE_SMALL_URL’, ‘FULL_NAME’, ‘BLOCKED_BY_ME’, ‘STOREFRONT_SEARCH_PLACEHOLDER’, ‘PROFILE_VIEWS’, ‘SEO_CANONICAL_DOMAIN’, ‘IMPLICITLY_FOLLOWED_BY_ME’, ‘IS_GEO_ELIGIBLE_FOR_CREATOR_MESSAGING’, ‘SEO_DESCRIPTION’, ‘INSPIRATIONAL_MERCHANT_REVIEW_LABELS’, ‘SUBSCRIBED_TO_NOTIFICATIONS’, ‘CONNECTION_TYPE’, ‘IS_PRIMARY_WEBSITE_VERIFIED’, ‘PIN_THUMBNAIL_URLS’, ‘IMPRESSUM_URL’, ‘PROFILE_REACH’, ‘IS_COUNTRY_ELIGIBLE_FOR_LEAD_FORM_AUTOFILL’, ‘IS_NAME_ELIGIBLE_FOR_LEAD_FORM_AUTOFILL’, ‘EPIK’, ‘ACTIVE’, ‘SHUFFLES_PROFILE_IMAGES’, ‘SHOULD_SHOW_MESSAGING’, ‘HAS_CUSTOM_BOARD_SORTING_ORDER’, ‘TYPE’, ‘LAST_NAME’, ‘USER_FOLLOWING_COUNT’, ‘PROFILE_DISCOVERED_PUBLIC’, ‘LAST_PIN_SAVE_TIME’, ‘EXPLICITLY_FOLLOWED_BY_ME’, ‘IS_ANY_WEBSITE_VERIFIED’, ‘STOREFRONT_SEARCH_QUERY_PARAMS’, ‘FACEBOOK_FRIENDS’, ‘INDEXED’, ‘DEBUG’, ‘LAST_PIN_LIKE_TIME’, ‘SHOW_DISCOVERED_FEED’, ‘IS_STORY_PIN_CREATOR’, ‘IS_TRUSTED_DEVELOPER’, ‘MESSAGING_PERMISSIONS_FOLLOWERS’, ‘HAS_PUBLISHED_PINS’, ‘DOMINANT_COLOR_RGB’, ‘PROFILE_COVER_SOURCE_ID’, ‘FOLLOWED_BY_ME’, ‘IS_VERIFIED_MERCHANT’, ‘IS_GENDER_ELIGIBLE_FOR_LEAD_FORM_AUTOFILL’, ‘PROFILE_COVER_SOURCE_TYPE’, ‘PROFILE_COVER_SOURCE_SOURCE’, ‘CREATED_AT’, ‘IMAGE_LARGE_URL’
New columns in report result - ‘ACCOUNT_TYPE’, ‘BUSINESS_NAME’, ‘MONTHLY_VIEWS’, ‘PROFILE_IMAGE’
Batch Advertiser Entities Report
Renamed inputs in the UI -
Entity End Level → Entity type,
Filters Objective Type → Objective Type
Deprecated columns in the report result - ‘VIEW_TRACKING_URL’, ‘QUIZ_PIN_DATA’, ‘OBJECTIVE_TYPE’, ‘CONVERSION_LEARNING_MODE_TYPE’, ‘INCLUDED’, ‘CLICK_TRACKING_URL’, ‘NAME’, ‘TYPE’, ‘CREATIVE_TYPE’, ‘HOLDOUT_EXPERIMENT_CELL’, ‘ADVERTISER_ID’, ‘BUDGET_IN_MICRO_CURRENCY’, ‘CAMPAIGN_BUDGET_OPTIMIZATION_ENABLED’, ‘CREATION_CONTEXT_USER_ID’, ‘LEAD_FORM_ID’, ‘START_TIME’, ‘TRACKING_URL’, ‘TARGETING_SPEC_GENDER’, ‘TARGETING_SPEC_SHOPPING_RETARGETING’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_ATTRIBUTION_WINDOWS_CLICK_WINDOW_DAYS’, ‘FREQUENCY_CAP’, ‘REVIEW_STATUS’, ‘PREMIERE_SPOTLIGHT_ENABLED’, ‘END_TIME’, ‘PLACEMENT_GROUP’, ‘CATALOG_PRODUCT_GROUP_ID’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_LEARNING_MODE_TYPE’, ‘CATALOG_TYPE’, ‘OPTIMIZATION_GOAL_METADATA_OUTBOUND_CLICK_GOAL_METADATA_IS_OUTBOUND_CLICK_OPTIMIZED’, ‘IS_PIN_DELETED’, ‘TARGETING_SPEC_LOCALE’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_IS_ROAS_OPTIMIZED’, ‘COLLECTIONS_HEADER_TYPE’, ‘INTEGRATION_PLATFORM_EQUIVALENT_ID’, ‘IOS_DEEP_LINK’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_CONVERSION_EVENT’, ‘OPTIMIZATION_GOAL_METADATA_SCROLLUP_GOAL_METADATA’, ‘PACING_DELIVERY_TYPE’, ‘CREATION_CONTEXT_CLIENT_TYPE’, ‘FLEXIBLE_DAILY_BUDGETS_ENABLED’, ‘CAROUSEL_IOS_DEEP_LINKS’, ‘CREATION_CONTEXT_LDAP’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_ATTRIBUTION_WINDOWS_ENGAGEMENT_WINDOW_DAYS’, ‘CAMPAIGN_BOOKING_REFERENCE’, ‘TARGETING_SPEC_AUDIENCE_INCLUDE’, ‘TARGETING_SPEC_INTEREST’, ‘TARGETING_PROFILE_ID’, ‘DEFINITION’, ‘IS_REMOVABLE’, ‘HOLDOUT_SURVEY’, ‘TARGETING_SPEC_TARGETING_STRATEGY’, ‘CAROUSEL_ANDROID_DEEP_LINKS’, ‘PIN_ID’, ‘TARGETING_SPEC_APPTYPE’, ‘BID_IN_MICRO_CURRENCY’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_ATTRIBUTION_WINDOWS_VIEW_WINDOW_DAYS’, ‘DESTINATION_URL’, ‘REJECTION_LABELS’, ‘PLACEMENT_TRAFFIC_TYPE’, ‘BUDGET_TYPE’, ‘DELIVERY_REPORT_ADVERTISER_ID’, ‘CUSTOMIZABLE_CTA_TYPE’, ‘LEAD_ID’, ‘TARGETING_SPEC_AGE_BUCKET’, ‘TARGETING_SPEC_LOCATION’, ‘_ID’, ‘CATALOG_PRODUCT_GROUP_NAME’, ‘TRACKING_URLS’, ‘CREATION_CONTEXT_CLIENT_ID’, ‘IS_MDL’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_CPA_GOAL_VALUE_IN_MICRO_CURRENCY’, ‘HOLDOUT_EXPERIMENT’, ‘OPTIMIZATION_GOAL_METADATA_FREQUENCY_GOAL_METADATA’, ‘BILLABLE_EVENT’, ‘DCA_ASSETS’, ‘DELIVERY_REPORT_OWNER_USER_ID’, ‘CATALOG_ID’, ‘RELATIVE_DEFINITION’, ‘ID’, ‘CAROUSEL_DESTINATION_URLS’, ‘IS_AUTOMATED_CAMPAIGN’, ‘BRAND_SFDC_ACCOUNT_ID’, ‘TARGETING_SPEC_AUDIENCE_EXCLUDE’, ‘FEED_PROFILE_ID’, ‘ANDROID_DEEP_LINK’, ‘CREATED_TIME’, ‘UPDATED_TIME’, ‘DELIVERY_REPORT_ADVERTISER_NAME’, ‘SUMMARY_STATUS’, ‘PARENT_ID’, ‘OPTIMIZATION_GOAL_METADATA_CONVERSION_TAG_V3_GOAL_METADATA_CONVERSION_TAG_ID’, ‘INTEGRATION_PLATFORM_TYPE’
New columns in report result - ‘CAMPAIGN_HOLDOUT_EXPERIMENT_CELL’, ‘QUIZ_QUESTION_3_TEXT’, ‘CAROUSEL_SLOT_4_ANDROID_DEEP_LINK’, ‘ATTRIBUTION_WINDOWS_VIEW’, ‘IMAGE_FILE_NAME’, ‘QUIZ_RESULT_3_DESTINATION_URL’, ‘NOTIFICATION_ID’, ‘CAROUSEL_SLOT_4_TITLE’, ‘PIN_PROMOTION_STATUS’, ‘AD_GROUP_END_TIME’, ‘AD_GROUP_TRACKING_URLS’, ‘QUIZ_RESULT_2_ORGANIC_PINID’, ‘CAROUSEL_SLOT_4_PIN_PROMOTION_URL’, ‘AD_GROUP_PLACEMENT’, ‘PIN_PROMOTION_CREATIVE_TYPE’, ‘CAMPAIGN_HOLDOUT_EXPERIMENT’, ‘TARGETING_SPEC_AGE_BUCKETS’, ‘AD_GROUP_UPDATED_TIME’, ‘TARGETING_SPEC_GENDERS’, ‘ACTION’, ‘CAROUSEL_SLOT_1_PIN_PROMOTION_URL’, ‘QUIZ_RESULT_2_DESTINATION_URL’, ‘CAROUSEL_SLOT_2_PIN_PROMOTION_URL’, ‘CAMPAIGN_STATUS’, ‘TARGETING_SPEC_LOCATIONS’, ‘TARGETING_SPEC_SHOPPING_EVENT_TAGS’, ‘PIN_DESCRIPTION’, ‘PRODUCT_GROUP_REF_ID’, ‘PIN_PROMOTION_ID’, ‘CONVERSION_EVENT’, ‘AD_GROUP_CREATED_TIME’, ‘CPA_GOAL_VALUE_IN_MICROCURRENCY’, ‘QUIZ_RESULT_1_DESTINATION_URL’, ‘CAROUSEL_SLOT_3_ORGANIC_PIN_URL’, ‘CAROUSEL_SLOT_3_IMAGE_FILE_NAME’, ‘CAROUSEL_SLOT_2_IOS_DEEP_LINK’, ‘PRODUCT_GROUP_ID’, ‘CAROUSEL_SLOT_1_PIN_DESCRIPTION’, ‘TARGETING_SPEC_SHOPPING_EXCLUSION_WINDOW’, ‘ORGANIC_PIN_ID’, ‘PRODUCT_GROUP_NAME’, ‘CAROUSEL_SLOT_5_TITLE’, ‘AD_GROUP_STATUS’, ‘AD_GROUP_NAME’, ‘QUIZ_RESULT_1_IOS_DEEP_LINK_URL’, ‘CAROUSEL_SLOT_1_ANDROID_DEEP_LINK’, ‘CAROUSEL_SLOT_3_PIN_DESCRIPTION’, ‘CAROUSEL_SLOT_3_ANDROID_DEEP_LINK’, ‘TARGETING_SPEC_DEVICES’, ‘PIN_PROMOTION_UPDATED_TIME’, ‘CAROUSEL_SLOT_5_PIN_PROMOTION_URL’, ‘CAROUSEL_SLOT_4_PIN_DESCRIPTION’, ‘PIN_PROMOTION_CREATED_TIME’, ‘CAROUSEL_SLOT_1_ORGANIC_PIN_URL’, ‘ENTITY_TYPE’, ‘TARGETING_SPEC_GEOS’, ‘ATTRIBUTION_WINDOWS_CLICK’, ‘CAROUSEL_SLOT_4_IOS_DEEP_LINK’, ‘QUIZ_RESULT_3_ANDROID_DEEP_LINK_URL’, ‘CAMPAIGN_HOLDOUT_SURVEY’, ‘CONVERSION_TAG_ID’, ‘FREQUENCY_TARGET’, ‘MATCH_TYPE’, ‘CAROUSEL_SLOT_1_IOS_DEEP_LINK’, ‘TARGETING_SPEC_SHOPPING_LOOKBACK_WINDOW’, ‘CAROUSEL_SLOT_4_IMAGE_FILE_NAME’, ‘CAROUSEL_SLOT_5_IMAGE_FILE_NAME’, ‘PIN_TITLE’, ‘CAROUSEL_SLOT_2_PIN_DESCRIPTION’, ‘AD_GROUP_START_TIME’, ‘PIN_PROMOTION_REJECTED_REASONS’, ‘AD_GROUP_PACING_TYPE’, ‘CAROUSEL_SLOT_5_IOS_DEEP_LINK’, ‘CAROUSEL_SLOT_2_TITLE’, ‘CAROUSEL_SLOT_2_ANDROID_DEEP_LINK’, ‘CAROUSEL_SLOT_5_ANDROID_DEEP_LINK’, ‘CAROUSEL_SLOT_5_ORGANIC_PIN_URL’, ‘CAROUSEL_SLOT_2_ORGANIC_PIN_URL’, ‘PIN_PROMOTION_NAME’, ‘PRODUCT_GROUP_TRACKING_URL’, ‘CAMPAIGN_UPDATED_TIME’, ‘TARGETING_SPEC_INCLUDED_AUDIENCES’, ‘CAROUSEL_SLOT_4_ORGANIC_PIN_URL’, ‘CAMPAIGN_TRACKING_URLS’, ‘PIN_PROMOTION_URL’, ‘CAMPAIGN_END_TIME’, ‘QUIZ_RESULT_2_IOS_DEEP_LINK_URL’, ‘CAROUSEL_SLOT_3_TITLE’, ‘CAROUSEL_SLOT_3_IOS_DEEP_LINK’, ‘CAROUSEL_SLOT_5_PIN_DESCRIPTION’, ‘AD_GROUP_BUDGET’, ‘ORGANIC_PIN_URL’, ‘KEYWORD_ID’, ‘PIN_PROMOTION_REVIEW_STATUS’, ‘KEYWORDS’, ‘ORGANIC_PIN_DELETED’, ‘AD_GROUP_BUDGET_TYPE’, ‘QUIZ_QUESTION_2_TEXT’, ‘QUIZ_QUESTION_1_TEXT’, ‘CAMPAIGN_START_TIME’, ‘CAROUSEL_SLOT_1_TITLE’, ‘QUIZ_QUESTION_3_OPTIONS’, ‘BID’, ‘QUIZ_RESULT_1_ANDROID_DEEP_LINK_URL’, ‘TARGETING_SPEC_INTERESTS’, ‘CAMPAIGN_CREATED_TIME’, ‘PRODUCT_GROUP_ACTIVE’, ‘KEYWORD_STATUS’, ‘AD_GROUP_BILLABLE_EVENT’, ‘PP_TRACKING_URLS’, ‘QUIZ_RESULT_3_ORGANIC_PINID’, ‘CAMPAIGN_START_DATE’, ‘BID_TYPE’, ‘CAROUSEL_SLOT_3_PIN_PROMOTION_URL’, ‘QUIZ_RESULT_2_ANDROID_DEEP_LINK_URL’, ‘IS_FDB’, ‘QUIZ_QUESTION_2_OPTIONS’, ‘IS_CBO’, ‘ATTRIBUTION_WINDOWS_ENGAGEMENT’, ‘QUIZ_RESULT_3_IOS_DEEP_LINK_URL’, ‘CAMPAIGN_NAME’, ‘QUIZ_RESULT_1_ORGANIC_PINID’, ‘QUIZ_QUESTION_1_OPTIONS’, ‘FREQUENCY_TARGET_TIME_RANGE’, ‘CAMPAIGN_BRAND_SFDC_ACCOUNT_ID’, ‘TARGETING_SPEC_EXCLUDED_AUDIENCES’, ‘TARGETING_SPEC_LANGUAGES’, ‘CAROUSEL_SLOT_2_IMAGE_FILE_NAME’, ‘CAROUSEL_SLOT_1_IMAGE_FILE_NAME’, ‘CAMPAIGN_END_DATE’
You can find the changes for the Ad delivery report: Pinterest API Upgrade to V5 - Ad Delivery report