Segments

The formo segments command group lets you manage user segments. Segments are saved audience filters that you can use throughout the Formo platform.

`formo segments list`

List all user segments for the project.

Requires segments:read scope on your API key.

Options

Option	Type	Required	Description
`--page`	`number`	❌	Page number, 1-indexed
`--size`	`number`	❌	Page size

formo segments list --size 25

`formo segments create`

Create a new user segment.

Requires segments:write scope on your API key.

Options

Option	Type	Required	Description
`--title`	`string`	✅	Segment title
`--filters`	`string`	✅	JSON array of canonical `{field, op, value}` filter objects

Examples

# Create a high-value segment
formo segments create \
  --title "Whales" \
  --filters '[{"field":"net_worth_usd","op":"gt","value":100000}]'

# Create a power-user segment
formo segments create \
  --title "Power Users" \
  --filters '[{"field":"tx_count","op":"gt","value":100},{"field":"num_sessions","op":"gt","value":10}]'

`formo segments delete`

Delete a user segment.

Requires segments:write scope on your API key.

Arguments

Argument	Type	Required	Description
`segmentId`	`string`	✅	Segment ID to delete

formo segments delete seg_abc123

Deleting a segment is permanent.

CLI

Commands

`formo segments list`

Options

`formo segments create`

Options

Examples

`formo segments delete`

Arguments

​formo segments list

​Options

​formo segments create

​Options

​Examples

​formo segments delete

​Arguments

`formo segments list`

Options

`formo segments create`

Options

Examples

`formo segments delete`

Arguments