Get aggregated earnings summary

Returns pre-aggregated earnings metrics for the authenticated creator, including all-time totals, month-over-month comparisons, source/type breakdowns, chart series, and averages.

Almost every money field pairs gross (pre-fee earnings) with net (the creator's cut after Fanvue fees); refunds and chargebacks are left out of both rather than subtracted. The exception is averageByDayOfWeek and averageByHourOfDay: both are gross-only scalars with no net counterpart to select. gross is not always money a fan paid: referral, affiliate and giveaway earnings are creator rewards that no fan paid for, and they reach this summary through referrals and other.

Unlike the fan insights endpoints, results here are cached for up to 10 minutes per creator and per parameter set, so a figure can lag a payment that has already settled.

get/insights/earnings/summary

Query parameters

startDatestring date-time

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z).

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z).

endDatestring date-time

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included.

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included.

granularity'day' | 'week'

Aggregation granularity for the over-time chart

Aggregation granularity for the over-time chart

timezonestring

IANA timezone used for period grouping and month boundaries (e.g., Europe/London, America/New_York)

IANA timezone used for period grouping and month boundaries (e.g., Europe/London, America/New_York)

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Aggregated earnings summary

averageByHourOfDayobject required

Average gross earnings by hour-of-day in the selected timezone (0-23)

Changes