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>'
import requests

url = "https://api.formo.so/v0/frequency"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.formo.so/v0/frequency', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.formo.so/v0/frequency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.formo.so/v0/frequency"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.formo.so/v0/frequency")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.formo.so/v0/frequency")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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
}
{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}
{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}

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