Changelog

Version 1.0.0

November 2020

Initial Release

December 16, 2020

In compliance with the European Union's ePrivacy Directive, Sprout’s Instagram Story Reply metrics will no longer include activity from users in the EEA. Click here for more information. Impacted metrics:

  • Instagram Owned Profile Metrics: Story Replies story_replies
  • Instagram Owned Post Metrics: Story Replies lifetime.comments_count

April 6, 2021

Clarified the fields available for each network for posts.

June 23, 2022

Updated language to differentiate more clearly between a Message and a sent Post.

August 26, 2022

Updated documentation to include the new Messages endpoint, which lives in a new endpoint collection. Includes multiple other minor updates:

  • added detail about request params for existing endpoints previously missing from the docs
  • more explicit error messages when a request fails validation
  • docs updated to include info on multiple new message/post types, including reviews networks, minor grammar fixes

September 13, 2022

Added support for clickthrough_link for TWITTER posts within the analytics/posts endpoint.

November 2, 2022

Documentation updates - changes to the Message Fields table:

  • sent field added for most message types
  • internal.from.* fields added for Youtube message types

November 30, 2022

Added support for inbox_permalink within the messages endpoint. This link navigates an authorized and logged-in Sprout user to the message thread for the message obtained via the API.

September 19, 2023

Documentation updates - changes to the Customer Profile metadata endpoint:

  • external_name for Pinterest profiles connected after June 6, 2023 now returns the Pinterest username.

September 25, 2023

Documentation updates - changes to the tag metadata endpoint:

  • type field added to indicate the tag type: LABEL or CAMPAIGN

November 6, 2023

Documentation updates - changes to the YouTube owned profile metrics:

  • posts_sent_count added to the list of owned profile metrics available for YouTube profiles.

December 21, 2023

Added support for Listening Topics. New endpoints to retrieve metrics and messages for Topics are now available. These new endpoints follow existing patterns and structures established across the analytics and metadata endpoints.

March 7, 2024

The following Facebook metrics are no longer available in the Sprout Analytics API. This change was made necessary by the deprecation of these metrics from Meta’s APIs.

NOTE: If you have Tableau workbooks utilizing these metrics, they will appear blank after this deprecation. You'll need to remove the deprecated metrics from the workbook to allow the visualizations to show.

Facebook: Owned Profile Metrics

  • Followers By Country lifetime_snapshot.followers_by_country
  • Followers By Age Gender lifetime_snapshot.followers_by_age_gender
  • Followers By City lifetime_snapshot.followers_by_city
  • Logged In Page Views profile_views_login
  • Logged Out Page Views profile_views_logout
  • Page Visitors profile_views_login_unique
  • Mobile Place Check-ins place_checkins_mobile
  • Page Content Activity profile_content_activity

Facebook: Post Metrics

  • Fan Organic Impressions lifetime.impressions_follower_organic
  • Fan Paid Impressions lifetime.impressions_follower_paid
  • Non-fan Organic Impressions lifetime.impressions_nonfollower_organic
  • Non-fan Paid Impressions lifetime.impressions_nonfollower_paid
  • Fan Paid Reach lifetime.impressions_follower_paid_unique
  • Users Talking About This lifetime.post_activity_unique
  • Unique Reactions lifetime.reactions_unique
  • Unique Comments lifetime.comments_count_unique
  • Unique Shares lifetime.shares_count_unique
  • Unique Answers lifetime.question_answers_unique

May 31, 2024

Added endpoints for creating/retrieving Publishing Posts and Media Upload

June 27, 2024

Post level video views and impressions metrics for Instagram and Facebook reels use total views for posts created after November 15, 2023 rather than number of initial views.

July 9, 2024

Documentation site uses automatically generated anchor links derived from markdown headers. Manually created anchors made from HTML divs are removed.

July 22, 2024

Documentation site illustrates how to generate a user-scoped OAuth 2.0 access token.