Goal customizations
Goal customizations control how tracked goals appear in the dashboard, API responses, and CLI output. They are useful when raw event names are developer-friendly, like
signup_started, but the dashboard should show "Signup started".These customizations are display-only:
- They do not rename historical events.
- They do not change what your client-side tracker or API should send.
- They can be removed at any time to return to the default raw goal name and automatic color.
Base path:
https://datafa.st/api/v1/admin| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| List goal customizations | GET | /websites/{websiteId}/goals/customizations | goals:read | List saved customizations and allowed colors |
| Update goal customization | PATCH | /websites/{websiteId}/goals/customizations | goals:write | Create or update display metadata for one goal |
| Delete goal customization | DELETE | /websites/{websiteId}/goals/customizations?goalName=... | goals:write | Remove saved display metadata for one goal |
Update a goal display
curl -X PATCH "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID/goals/customizations" \
-H "Authorization: Bearer dft_xxx" \
-H "Content-Type: application/json" \
-d '{
"goalName": "signup_started",
"displayName": "Signup started",
"color": "#8dcdff",
"description": "Visitor opened the signup flow"
}'
Pass
null for displayName, color, or description to clear that one field. Use DELETE to reset the entire customization.