Skip to content

Revenue growth data

projectId
required
string
startDate
string format: date

Inclusive window start (YYYY-MM-DD). Parsed with parseDateRangeParams; when either startDate or endDate is missing/invalid the route falls back to a rolling default window (30 days for events/visits/attribution, 7 days for growth).

endDate
string format: date

Inclusive window end (YYYY-MM-DD). See startDate for fallback behavior.

Revenue data. months is sorted ascending by month key. Monetary values are converted from minor units (amountMinor / 100) and rounded to 2 decimals, i.e. major currency units (元), not fen. month format is “YYYY-MM”. Only months that actually have revenue or active subjects appear — the series is NOT gap-filled. _meta.revenueEvents comes from the growth definition’s revenue stage. Error path (500): {error, detail}.

Media typeapplication/json
object
months
required
Array<object>
object
month
required

YYYY-MM (UTC)

string
newRevenue
required

Major units, 2 decimals.

number
expansion
required

Major units, 2 decimals.

number
total
required

Major units, 2 decimals.

number
arpu
required

Total / activeUsers, 2 decimals; 0 when no active subjects.

number
activeUsers
required
integer
_meta
required
object
scope
required
string
Allowed values: EVENT SESSION VISITOR IDENTIFIED_USER ACCOUNT
scopeLabel
required
string
revenueEvents
required
Array<string>

Load failed.

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
json
{}