Analytics

List analytics per creator

GET/v1/analytics/creators

Net revenue by type and subscription counts for each creator over the window, sorted by revenue. Creators with no revenue in the window are absent. The subscriber counts are distinct-fan counts, which are markedly more expensive than the plain sums of the other endpoints: this endpoint caps the window at 90 days rather than 365.

Required scoperead:analytics

Rate limit20 requests per minute

curl 'https://api.fansquare.so/v1/analytics/creators?start=2026-09-01&end=2026-09-30&timezone=Europe%2FParis' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "name": "Lena",
      "total": 1284000,
      "by_type": {
        "tip": 312000,
        "subscription": 420000,
        "subscription_renewal": 238000,
        "booking": 0,
        "push": 214000,
        "mod": 0,
        "fan_to_creator": 100000,
        "creator_to_fan": 0,
        "affiliate": 0,
        "affiliation": 0
      },
      "subscribers": {
        "new": 38,
        "renewal": 54,
        "paying_fans": 212
      }
    }
  ],
  "currency": "EUR"
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Query

startstringrequired
First day of the window (inclusive), e.g. 2026-07-01. Interpreted in timezone. A date-time is accepted too and floored to its local day.
endstringrequired
Last day of the window (inclusive: the whole day is covered), e.g. 2026-07-31. Interpreted in timezone. The window cannot exceed 365 days (and less for the finer bucket sizes of the timeseries endpoint); fetch older history with additional requests.
timezonestring
IANA timezone the window and buckets are computed in, canonical Area/Location form (e.g. Europe/Paris). Abbreviations like CET are rejected. Defaults to UTC.
creator_idsstring
Restrict to these creators (Fansquare ids from GET /v1/creators). Omit for every creator the key can see. Comma-separated, 50 max.

Response

OK, application/json

dataarray of objectsrequired
creator_idstringrequired
Fansquare creator id.
namestringrequired
Creator display name.
totalintegerrequired
Total net revenue, EUR cents.
by_typeobjectrequired
Net revenue in EUR cents per order type, every type present and zero-filled (affiliate revenue is grouped under affiliation).
tipintegerrequired
subscriptionintegerrequired
subscription_renewalintegerrequired
bookingintegerrequired
pushintegerrequired
modintegerrequired
fan_to_creatorintegerrequired
creator_to_fanintegerrequired
affiliateintegerrequired
affiliationintegerrequired
subscribersobjectrequired
newintegerrequired
Distinct fans with a first subscription in the window.
renewalintegerrequired
Distinct fans with a subscription renewal in the window.
paying_fansintegerrequired
Distinct fans with at least one paid order in the window.
currency"EUR"required

curl 'https://api.fansquare.so/v1/analytics/creators?start=2026-09-01&end=2026-09-30&timezone=Europe%2FParis' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "name": "Lena",
      "total": 1284000,
      "by_type": {
        "tip": 312000,
        "subscription": 420000,
        "subscription_renewal": 238000,
        "booking": 0,
        "push": 214000,
        "mod": 0,
        "fan_to_creator": 100000,
        "creator_to_fan": 0,
        "affiliate": 0,
        "affiliation": 0
      },
      "subscribers": {
        "new": 38,
        "renewal": 54,
        "paying_fans": 212
      }
    }
  ],
  "currency": "EUR"
}