Skip to main content
GET
/
v0
/
frequency
Get visit-frequency distribution
curl --request GET \
  --url https://api.formo.so/v0/frequency \
  --header 'Authorization: Bearer <token>'
{
  "meta": [
    {
      "name": "project_id",
      "type": "String"
    },
    {
      "name": "session_bucket",
      "type": "String"
    },
    {
      "name": "user_count",
      "type": "UInt64"
    },
    {
      "name": "avg_session_per_user",
      "type": "Float64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "session_bucket": "1 session",
      "user_count": 412,
      "avg_session_per_user": 1
    },
    {
      "project_id": "proj_abc",
      "session_bucket": "2 - 10 sessions",
      "user_count": 287,
      "avg_session_per_user": 4.6
    },
    {
      "project_id": "proj_abc",
      "session_bucket": "10 - 30 sessions",
      "user_count": 76,
      "avg_session_per_user": 16.2
    },
    {
      "project_id": "proj_abc",
      "session_bucket": "30 - 50 sessions",
      "user_count": 18,
      "avg_session_per_user": 38.4
    },
    {
      "project_id": "proj_abc",
      "session_bucket": "> 50 sessions",
      "user_count": 5,
      "avg_session_per_user": 84
    }
  ],
  "rows": 5,
  "rows_before_limit_at_least": 5
}
Returns how many users visited 1, 2, 3+ times in the selected window - the data behind the dashboard’s frequency histogram.

Authorizations

​
Authorization
string
header
required

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

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.

​
lifecycle_filter
enum<string>

Restrict results to a single lifecycle stage.

Available options:
New,
Returning,
Power user,
Resurrected,
At Risk,
Churned
​
include_previous_period
boolean

When true, returns both current and previous period metrics for week-over-week comparison. The previous period is non-overlapping and equal in length to the current range.

Response

Visit frequency distribution

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