CLI — Goals

List tracked goals and customize how they appear in the dashboard, chart tooltips, API responses, and CLI output.

For REST usage, see Account API goal customizations.

Run datafast goals to choose a command interactively. Commands prompt for the website and goal when omitted, and every picker includes Cancel. You can also press Ctrl+C to exit.

List tracked goals

datafast goals
datafast goals list
datafast goals list <websiteId>

The list includes completion counts and any saved display name, color, or description.

List saved customizations

datafast goals customizations <websiteId>
datafast goals customizations <websiteId> --goal signup_started

This only returns goals that have saved display metadata.

List allowed colors

datafast goals colors <websiteId>

Use one of these hex colors with datafast goals customize --color. The dashboard uses this same palette.

Customize a goal

Goal customizations are display-only. Keep sending the original raw goal name from your JavaScript tracker, SDK, or API.

# Interactive editor
datafast goals customize

# Non-interactive update
datafast goals customize <websiteId> signup_started \
  --display-name "Signup started" \
  --color "#8dcdff" \
  --description "Visitor opened the signup flow"

Clear one field by passing a clear flag:

datafast goals customize <websiteId> signup_started --clear-color
datafast goals customize <websiteId> signup_started --clear-description
datafast goals customize <websiteId> signup_started --clear-display-name

Reset a goal customization

datafast goals reset <websiteId> signup_started

# Skip confirmation
datafast goals reset <websiteId> signup_started --yes

Resetting removes the saved display name, color, and description. It does not delete the tracked goal events.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown