Sprout Public API
With the Sprout Public API you can extend the functionality of Sprout’s analytics tools so you can integrate your owned social data with your analytics and business intelligence tools outside of Sprout. You can use the API to fulfill all of your most unique reporting needs and integrate social data in your broader tools and analytics processes.
Note: Only those with Premium Analytics can access the API. If you would like to use this API, contact your Customer Success Manager.
To better understand how to leverage this API, let’s look at a few use cases.
Custom Dashboards - Think of a large retail brand that just launched a new social campaign. The brand might want to display the top-performing posts throughout their office, so all employees can see the success of the posts. The brand can call the API to gather post data across their networks and display the data in their custom tool to display in the office.
Custom Reports - Think of a college that wants to ensure all their materials match the school colors and fonts. The college can call the API to gather profile and post data and use this data in their own reporting tool. This way, the colors shown in the report match the school colors and the font also reflects the college’s branding.
Customer-specific KPIs - Think of a restaurant group. They might have distinct performance metrics and goals for their social teams. If they want to create a custom metric around brand awareness that includes impressions + profile views + video views, they can call the API to provide these data points and combine the metrics.
How it works
The API is available for X, Facebook, Instagram, LinkedIn, Pinterest, YouTube and TikTok. It includes data from the following Sprout reports:
- Post Performance Report
- Facebook Pages Report
- Instagram Business Profiles Report
- Twitter Profiles Report
- LinkedIn Pages Report
- Pinterest Profiles Report
- TikTok Profiles Report
- YouTube Videos Report
The API includes read-only, owned profile data for profile performance, published post performance and tags. The API includes read-only data because you can only retrieve this data, not write this data, since it comes from the performance of profiles and posts.
The API provides similar functionality to Sprout’s CSV exports, but is tailored for a different use case. You might already export your data to a CSV to import that data into software like Excel. The CSV workflow works well for these scenarios, but isn’t a great way for other software to consume this data. The API provides a more streamlined way for your software to access your analytics data in Sprout. Access our API documentation with this link.
The API doesn’t include:
- Paid or ad account data
- Competitor data
- BI connectors
- Account or Profile management
- Publishing API
Let’s break down what data you can access.
For owned profiles, you can access:
- Profile metadata including the profile ID, username and description
- Sprout profile authentication status
Profile-level analytics aggregated on a daily basis, using the network’s time zone. This includes:
- Audience/follower count
- Message data, including:
Received Inbox Messages
Sent Inbox Replies
Sent Review Replies
- Customer care data (replies, likes, completes and tags in Sprout)
For published posts for owned profiles, you can access:
- Post metadata including the post ID, URL, content type and creation date of the post
- Post contents including text, links, media and URLs
- Sprout post metadata including post tags and the post author or Sprout user
- Post-level lifetime analytics including:
Data from Listening Topics, metrics and messages are included. Data from X is currently unavailable due to network API limitations.
Note: Each network has a different definition of engagements. You can find network-specific definitions in the Sprout Public API documentation for Twitter, Facebook, Instagram, YouTube, LinkedIn, Pinterest and TikTok.