Skip to main content
GET
Get the audience

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Query Parameters

creatorId
string | null

Only this creator (cre_…). Without it, every creator the credential can see. A creator the credential cannot see is 404 CREATOR_NOT_FOUND, never an empty report.

Required string length: 1 - 64

Response

The fans by status, renewal, spend band, activity and retention.

Who the fans are: subscription status, renewal, spend and activity. New fields may be added.

activity
AudienceActivity · object
required

Fans who wrote to a creator recently.

asOf
string | null
required

When the activity figures were computed (UTC).

fans
AudienceFans · object
required
renewal
AudienceRenewal · object
required

Auto-renew among active fans.

retention
AudienceRetention · object
required

Week-over-week: of the fans who wrote in one week, how many wrote again the next.

spendBands
SpendBand · object[]
required

Fans by lifetime spend, every band listed.

timezone
string
required