get_analytics
Fetch Substack analytics: 16 reports on retention, unsubscribes, growth sources, referrals, audience overlap, subscriber notes, paid growth, subscriber/follower/ARR timeseries. Optional date window.
Instructions
Read one publication-level analytics report, covering the dashboard's Stats tabs: cohort retention, unsubscribes and their reasons, growth sources, referrals, audience overlap with other Substacks, subscriber Notes, paid growth, and timeseries for subscribers, followers and ARR. For per-post numbers use get_post_stats instead. Pick a report with report; the ones covering a period accept from_date and to_date and otherwise default to the last 30 days.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many rows to return. Only used by audience_overlap and subscriber_notes, which default to 6 and 8. | |
| report | Yes | Which report to read. unsubscribes — Unsubscribes in a window, broken down by the reason given. unsubscribes_timeseries — Unsubscribes over time. retention — Cohort retention: how much of each signup cohort is still subscribed months later. retention_summary — Headline retention rates at 1, 6 and 12 months. referrals_leaderboard — Which subscribers have referred the most readers. referrals_summary — Gifts sent, accepted and converted. audience_overlap — Other Substacks whose audience overlaps yours, with the overlap percentage — the publications worth collaborating with. audience_locations — How many distinct countries and US states your subscribers span. subscriber_notes — Recent Notes written by your subscribers. paid_subscriber_growth — Paid growth rate for the period, with new subscriptions and expirations. arr_timeseries — Annual recurring revenue over time. followers_timeseries — Follower count over time. subscribers_timeseries — Subscriber count over time. growth_sources — Where new subscribers came from in a window, ranked by how many each source brought. growth_events — The individual growth events in a window. network_attribution — What share of your subscribers arrived through the Substack network rather than your own channels. | |
| to_date | No | End of the window, as YYYY-MM-DD. Defaults to today. | |
| from_date | No | Start of the window, as YYYY-MM-DD. Only used by the reports that cover a period; defaults to 30 days ago, or a year ago for retention. |