Skip to main content
GET
Home > Overview cumulative-revenue trend chart with comparators + band

Authorizations

Authorization
string
header
required

Bearer token authentication. Requires a company-admin token whose role holds reports.view. Additionally, the caller's company must have ANALYTICS_DASHBOARD enabled — otherwise every endpoint returns 404.

Query Parameters

country
string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

Response

Trend chart payload

current_month
object[]
required

One entry per day of the current calendar month up through today. cumulative_revenue is a running sum reset on the first of the month.

last_month
object[]
required

The full previous calendar month's cumulative-revenue curve, for the vs-last-month toggle.

last_year
object[]
required

The same calendar month one year ago, for the vs-last-year toggle.

expected_band
object[]
required

Cumulative expected-range envelope for the current month, computed from the DOW-based Q1/median/Q3 of the trailing 180 days of paid revenue. Empty when the tenant has no history in the trailing window yet.

currency
string
required

ISO 4217 three-letter code (uppercase).

Required string length: 3
Example:

"USD"

meta
object