Sign in

v24

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012843108.3 KB
Goals

Create Goal

Create a durable goal. Metrics are optional and other goals are never changed implicitly.

  • title: The goal title/description (1-500 characters)
  • goal_type: Optional metric type: boolean, scale, or numeric
  • target_value: Optional target value
  • current_value: Optional current progress
  • min_value: Optional minimum scale value
  • max_value: Optional maximum scale value
  • unit: Optional unit label (e.g., 'users', 'points')

Omit all metric fields to create a qualitative goal.

post/v1/dev/user/goals

Request body

current_valuenumber nullable

Optional current progress

desired_outcomestring nullable
goal_type'boolean' | 'scale' | 'numeric'
horizon_atstring date-time nullable
max_valuenumber nullable

Optional maximum scale value

min_valuenumber nullable

Optional minimum scale value

success_criteriastring[]
target_valuenumber nullable

Optional target value

titlestring required

The goal title/description

unitstring nullable

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

why_it_mattersstring nullable

Response

Successful Response

created_atstring date-time required
current_valuenumber required
desired_outcomestring required
focus_rankinteger nullable
goal_idstring required
goal_typestring required
horizon_atstring date-time nullable
idstring required
is_activeboolean required
max_valuenumber required
min_valuenumber required
sourcestring required
statusstring required
success_criteriastring[]
target_valuenumber required
titlestring required
unitstring nullable
updated_atstring date-time required
why_it_mattersstring nullable