Sign in

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.

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)