List the Sprout customer IDs this API token can access.

Use when SPROUT_CUSTOMER_ID is unknown or you need to confirm which Sprout account the token points at. Returns customer_id and name for each.

List the social profiles connected to this Sprout customer.

Start here: every analytics call is scoped by customer_profile_id, and this is the only place those IDs come from. Each profile includes customer_profile_id, network_type (facebook, instagram, tiktok, linkedin, twitter, youtube, pinterest, threads, bluesky), name, native_name and native_id.

Pull profile-level analytics for a date range (daily granularity).

Args: profile_ids: customer_profile_id values from list_profiles. Max 100. start_date: inclusive start, YYYY-MM-DD. end_date: exclusive end, YYYY-MM-DD. Range must be <= 1 year. metrics: metric keys to request, e.g. ["impressions", "lifetime_snapshot.followers_count", "net_follower_growth"]. Keys are network-specific -- call list_metrics to see valid ones. Omit to let Sprout return its defaults. page: 1-based page to start from. all_pages: follow pagination and concatenate the data arrays. max_pages: cap on pages fetched when all_pages is true.

Returns the API response verbatim: each record has dimensions (reporting_period.by(day), customer_profile_id) and metrics.

Note: rates such as engagement rate are NOT returned by Sprout -- they are derived. Compute them downstream from the raw counts.

Pull post-level analytics for posts created in a datetime range.

Args: profile_ids: customer_profile_id values from list_profiles. Max 100. start_datetime: inclusive, YYYY-MM-DDTHH:MM:SS (e.g. 2026-06-01T00:00:00). end_datetime: inclusive, YYYY-MM-DDTHH:MM:SS (e.g. 2026-06-30T23:59:59). metrics: post metric keys, mostly prefixed lifetime. -- e.g. ["lifetime.impressions", "lifetime.reactions", "lifetime.comments_count"]. A few are unprefixed (e.g. video_length on Facebook and TikTok). Network-specific; call list_metrics for valid keys. fields: post attributes to include, e.g. ["created_time", "text", "perma_link", "post_type", "internal.tags.id", "internal.sent_by.email"]. timezone: ICANN tz name for bucketing, e.g. "America/Los_Angeles". sort: sort expressions, e.g. ["lifetime.impressions:desc"]. page: 1-based page to start from (50 posts per page by default). all_pages: follow pagination and concatenate the data arrays. max_pages: cap on pages fetched when all_pages is true.

Returns the API response verbatim -- one record per post, carrying whichever fields and metrics were requested. Useful for per-post label/tag analysis.

Look up valid Sprout metric keys for a network, so calls don't guess.

Args: network: one of facebook, instagram, tiktok, linkedin, x, youtube, pinterest, threads, bluesky. Omit to list every network. scope: "profile" (for get_profile_metrics), "post" (for get_post_performance), or "all".

Each entry gives the human-readable name, the API key to send, and whether it needs Premium Analytics. Also lists Sprout's calculated metrics -- these are NOT returned by the API and must be derived from the raw counts.

This catalog was generated from the published docs; if the API rejects a key, check the live docs at https://api.sproutsocial.com/docs/.