get_growth_sources
Analyze subscriber growth by retrieving top growth sources for a specified date range, with optional event and timeseries data.
Instructions
Read growth sources for an ordered inclusive date range of at most 366 days ending no later than tomorrow UTC. One authenticated read, or two when include_events is true; no writes. Optional events report available items or an unavailable reason without discarding sources; authentication failure still stops the call. Returns up to 20 top-level sources by default, at most 50, in Substack's users-descending order. Processes at most 500 nodes, depth 3 and 400 timeseries points per metric; truncation flags identify cut data. total_sources and has_more describe only the unpaginated response's top-level array, not all upstream sources or complete attribution.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| to_date | Yes | ||
| from_date | Yes | ||
| include_events | No | ||
| include_timeseries | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| events | No | ||
| totals | Yes | ||
| sources | Yes | ||
| to_date | Yes | ||
| has_more | Yes | ||
| returned | Yes | ||
| from_date | Yes | ||
| truncated | Yes | ||
| publication | Yes | ||
| total_sources | Yes |