Read an analytics report
get_analyticsRetrieve Substack analytics reports on unsubscribes, retention, referrals, audience overlap, growth, and revenue. Use date ranges to analyze performance and guide strategy.
Instructions
Read one of the publication-level reports behind the dashboard's Stats tabs.
Reports:
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 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.
Reports covering a period default to the last 30 days, or the last year for retention.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Row cap, for the reports that take one. | |
| report | Yes | Which report to read. | |
| to_date | No | End of the window, YYYY-MM-DD. | |
| from_date | No | Start of the window, YYYY-MM-DD. Only used by reports covering a period. | |
| publication | No | Which connected publication to act on, matched loosely against its hostname (for example 'example.substack.com' or just 'example'). Defaults to the first connected publication. |