get_profile_metrics
Retrieve daily profile analytics for specified profiles within a date range. Supports custom metrics, pagination, and up to 100 profiles.
Instructions
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| metrics | No | ||
| end_date | Yes | ||
| all_pages | No | ||
| max_pages | No | ||
| start_date | Yes | ||
| profile_ids | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |