Sign in
Goals

Create Goal

Create a new goal. Supports up to 3 active goals; the oldest is deactivated if at max.

  • title: The goal title/description (1-500 characters)
  • goal_type: Type of goal metric: boolean, scale, or numeric (default: scale)
  • target_value: Target value to achieve
  • current_value: Current progress (default: 0)
  • min_value: Minimum scale value (default: 0)
  • max_value: Maximum scale value (default: 10)
  • unit: Optional unit label (e.g., 'users', 'points')
post/v1/dev/user/goals

Request body

current_valuenumber

Current progress value

goal_type'boolean' | 'scale' | 'numeric'
max_valuenumber

Maximum value of the scale

min_valuenumber

Minimum value of the scale

target_valuenumber required

Target value to achieve

titlestring required

The goal title/description

unitstring nullable

Unit label (e.g., 'users', 'points')

Response

Successful Response

created_atstring date-time required
current_valuenumber required
goal_typestring required
idstring required
is_activeboolean required
max_valuenumber required
min_valuenumber required
target_valuenumber required
titlestring required
unitstring nullable
updated_atstring date-time required

Changes