Get User Lifecycle

Get user lifecycle stages (New / Returning / Power user / Resurrected / At Risk / Churned)

curl --request GET \
  --url https://api.formo.so/v0/lifecycle \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.formo.so/v0/lifecycle', 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/lifecycle",
  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/lifecycle"

	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))

}

require 'uri'
require 'net/http'

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

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": "user_type",
      "type": "String"
    },
    {
      "name": "user_count",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "user_type": "New",
      "user_count": 184
    },
    {
      "project_id": "proj_abc",
      "user_type": "Returning",
      "user_count": 62
    },
    {
      "project_id": "proj_abc",
      "user_type": "Power user",
      "user_count": 23
    },
    {
      "project_id": "proj_abc",
      "user_type": "Resurrected",
      "user_count": 11
    },
    {
      "project_id": "proj_abc",
      "user_type": "At Risk",
      "user_count": 14
    },
    {
      "project_id": "proj_abc",
      "user_type": "Churned",
      "user_count": 142
    }
  ],
  "rows": 6,
  "rows_before_limit_at_least": 6
}

{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}

GET

lifecycle

Get user lifecycle stages (New / Returning / Power user / Resurrected / At Risk / Churned)

curl --request GET \
  --url https://api.formo.so/v0/lifecycle \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.formo.so/v0/lifecycle', 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/lifecycle",
  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/lifecycle"

	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))

}

require 'uri'
require 'net/http'

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

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": "user_type",
      "type": "String"
    },
    {
      "name": "user_count",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "user_type": "New",
      "user_count": 184
    },
    {
      "project_id": "proj_abc",
      "user_type": "Returning",
      "user_count": 62
    },
    {
      "project_id": "proj_abc",
      "user_type": "Power user",
      "user_count": 23
    },
    {
      "project_id": "proj_abc",
      "user_type": "Resurrected",
      "user_count": 11
    },
    {
      "project_id": "proj_abc",
      "user_type": "At Risk",
      "user_count": 14
    },
    {
      "project_id": "proj_abc",
      "user_type": "Churned",
      "user_count": 142
    }
  ],
  "rows": 6,
  "rows_before_limit_at_least": 6
}

{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "doc_url": "<string>",
    "param": "<string>",
    "details": {}
  }
}

Counts wallet users in each lifecycle stage, computed against the activity window ending at date_to. To return only one stage, add a lifecycle entry to the filters array, for example filters=[{"field":"lifecycle","op":"in","value":"Churned"}]. Pass include_previous_period=true to also receive the prior window.

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.

filters

string

Array of filter conditions, JSON-encoded in the query string. Entries use { field, op, value } and are combined with implicit AND. For example, filter traffic referred by Google with [{"field":"referrer","op":"contains","value":"google"}], or filter a page with [{"field":"page","op":"eq","value":"/pricing"}]. For in / nin, pass a non-empty array value such as ["chrome","firefox"] or a pipe-delimited string such as "chrome|firefox". Array string members cannot contain a literal |, which is reserved as the Tinybird membership separator. Optional one-level nested filters use the same canonical envelope and membership rule. On the user-aggregate endpoints (lifecycle, frequency) the same array also carries profile-family entries: profile metrics (net_worth_usd, volume, revenue, points), social identity fields, a lifecycle entry ({"field":"lifecycle","op":"in","value":"New|Power user"}), and resource entries using the stable fields chains.balance, apps.balance, tokens.balance, and labels.value with named qualifier properties (chain_id, app_id, token_address, scope, tag_id). The retired per-family parameters (socials, chain_filters, app_filters, token_filters, label_filters, profile_filters, lifecycle_filter) are rejected.

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.

behavior_filters

string

JSON array filtering users by event-based behavior with counts and either an absolute date range or a window relative to the user's first event. Each entry is { event, op, times, date_from?, date_to?, event_type?, relative_to?, window? }. When relative_to: "first_seen" is set, the matching events must occur within window.value window.unit (hour | day) after the user's first event; date_from/date_to are ignored. event_type narrows matching to a specific event-type column (page, connect, disconnect, chain, signature, transaction, track, decoded_log, detect, identify); for track and decoded_log the event field is the named identifier; for other types only the type column is matched.

source_filter

string

JSON array filtering users by raw event source. Entries use the canonical envelope and field must be source. Distinct from channel_filter, which matches the classified acquisition channel.

channel_filter

string

JSON array filtering users by classified acquisition channel. Entries use the canonical envelope and field must be channel_type. Distinct from source_filter, which matches the raw SDK source.

new_window_days

integer

Override: a wallet is New if first seen within this many days of the reference date (default 30). Caller value wins over the project's saved setting.