Skip to main content
GET
Revenue by channel

Authorizations

Authorization
string
header
required

A secret key (sk_live_… / sk_test_…) from Settings → API keys. Server-side only.

Query Parameters

from
string<date>

First day (inclusive), YYYY-MM-DD, by when answers were given. Default: 12 months ago.

to
string<date>

Last day (inclusive), YYYY-MM-DD. Default: today.

group_by
enum<string>
default:channel

channel for one row per channel; entity for one row per named source (plus a <slug>:none row per channel).

Available options:
channel,
entity
channel
string

Only this channel's rows, by slug, e.g. podcast.

Response

The report.

Example values are illustrative.

from
string<date>
required
to
string<date>
required
group_by
enum<string>
required
Available options:
channel,
entity
currency
string
required
Example:

"usd"

total_mrr_cents
integer
required
matched_mrr_cents
integer
required
unmatched_mrr_cents
integer
required
unmatched_share
number
required
paying_customers
integer
required
responses
integer
required
response_rate
number
required
rows
object[]
required
trend
object[]
required
headline
string | null
required