Skip to main content
GET
Get aggregated earnings summary
Required scope
  • read:insights — Access analytics, metrics, and insights data for performance tracking.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Query Parameters

startDate
string<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).

endDate
string<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.

granularity
enum<string>
default:day

Aggregation granularity for the over-time chart

Available options:
day,
week
timezone
string
default:UTC

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

Response

Aggregated earnings summary

totals
object
required
breakdownBySource
object
required
earningsByType
object
required
overTime
object[]
required
averageByDayOfWeek
object
required

Average gross earnings by ISO day-of-week (1=Monday, 7=Sunday)

averageByHourOfDay
object
required

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

period
object
required