List tracked goals

GET https://datafa.st/api/v1/admin/websites/{websiteId}/goals

List goal names already tracked on the website with completion counts and conversion rates. Useful before creating funnels or alerts that reference goal names.

Includes custom goals, payment-related goals, and any saved display customization fields.

Request

Path parameters

websiteId

string

Website ObjectId. From List websites (_id field). Example: 665f0b3c4d2e1a0012345678.

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data.

Response fields

data[].name

string

Human-readable name for the resource or event. The exact meaning depends on the endpoint.

data[].displayName

string|null

Custom display name, when saved.

data[].color

string|null

Custom chart color, when saved.

data[].description

string|null

Internal custom description, when saved.

data[].hidden

boolean

Whether a saved customization hides the goal in dashboard lists. Present when customized.

data[].total

number

Total completions/events.

data[].uv

number

Unique visitors who completed the goal.

data[].conversionRate

number

Conversion rate for the goal.

data[].eventType

string

Goal event type.

Authentication

Use a dft_ account token with settings:read.

A df_ website API key for the same website can also call this route when the path websiteId matches the key's website. Write access with a df_ key is capped at member level — owner-only actions such as team management require a dft_ token and owner role.

Errors

See API errors for the standard error envelope, auth failures, validation errors, permission errors, and rate limits.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown

{ "status": "success", "data": [{ "name": "signup", "displayName": "Signup", "color": "#8dcdff", "description": "Visitor created an account", "hidden": false, "total": 482, "uv": 391, "conversionRate": 0.081, "eventType": "custom" }] }