Analytics

List analytics per employee

GET/v1/analytics/employees

Attributed net/gross revenue per active employee over the window, sorted by net revenue. Resolve names with GET /v1/employees. unattributed_amount is revenue no employee is credited for; former_employees_amount is revenue attributed to since-removed employees.

Required scoperead:analytics

Rate limit20 requests per minute

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

{
  "data": [
    {
      "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
      "gross_amount": 927500,
      "net_amount": 742000,
      "by_type": {
        "tip": 300000,
        "subscription": 128000,
        "subscription_renewal": 0,
        "booking": 0,
        "push": 214000,
        "mod": 0,
        "fan_to_creator": 100000,
        "creator_to_fan": 0,
        "affiliate": 0,
        "affiliation": 0
      }
    }
  ],
  "unattributed_amount": 542000,
  "former_employees_amount": 0,
  "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
user_idstringrequired
Fansquare employee id.
gross_amountintegerrequired
Attributed gross revenue, EUR cents.
net_amountintegerrequired
Attributed 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
unattributed_amountintegerrequired
Net revenue with no employee attribution, EUR cents.
former_employees_amountintegerrequired
Net revenue attributed to removed employees, EUR cents.
currency"EUR"required

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

{
  "data": [
    {
      "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
      "gross_amount": 927500,
      "net_amount": 742000,
      "by_type": {
        "tip": 300000,
        "subscription": 128000,
        "subscription_renewal": 0,
        "booking": 0,
        "push": 214000,
        "mod": 0,
        "fan_to_creator": 100000,
        "creator_to_fan": 0,
        "affiliate": 0,
        "affiliation": 0
      }
    }
  ],
  "unattributed_amount": 542000,
  "former_employees_amount": 0,
  "currency": "EUR"
}