Skip to main content
GET
Get revenue and transaction volume time-series
Returns combined revenue and transaction-volume series for the selected window. Use group_by and rank_by to break the chart down by another dimension, and include_previous_period=true for week-over-week comparison.

Authorizations

Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.

Query Parameters

date_from
string<date>

Inclusive start date (YYYY-MM-DD). Defaults to 7 days before date_to.

date_to
string<date>

Inclusive end date (YYYY-MM-DD). Defaults to today.

group_by
string
limit
integer
rank_by
string
include_previous_period
boolean

Return current and previous period for WoW comparison

Response

Revenue and volume time-series

Analytics endpoint response. The data array contains the rows; the exact row shape depends on the endpoint. meta carries column type information for rendering, rows is the row count, and statistics holds query timing metadata.

data
object[]
meta
object[]
rows
integer
rows_before_limit_at_least
integer
statistics
object