Analyze goals

GET https://datafa.st/api/v1/analytics/goals

Return custom goal completions and unique visitors per goal name. Use this to rank which actions visitors take most often and compare goal performance across date ranges or audience segments.

When you request fields=name, the response key is goal (not name). Payment and subscription lifecycle goals are excluded — this endpoint covers custom goals only.

Related: Custom goals · Journey tracking

Request

Query parameters

fields

string

Comma-separated response columns. Omit to return all valid fields for this endpoint. Valid: name, completions, visitors. Requesting name returns the field as goal. Example: fields=name,completions,visitors.

websiteId

string

Required with a dft_ account token on Website API routes. Omit with a df_ website key. Example: ?websiteId=665f0b3c4d2e1a0012345678.

startAt

string

Start of the reporting window. Use YYYY-MM-DD for calendar days or an ISO timestamp. Must be provided together with endAt. Example: startAt=2026-05-01.

endAt

string

End of the reporting window. Must be provided together with startAt. Example: endAt=2026-05-21.

timezone

string

Timezone used to interpret dates and group analytics buckets. Defaults to the website timezone. IANA timezone for dashboard periods and API date grouping. Examples: "America/New_York", "Europe/Paris", "UTC". Defaults to the website timezone when omitted.

limit

number

Maximum rows to return. Default 100, maximum 1000 on analytics endpoints and 250 on list visitors. Example: limit=50.

offset

number

Rows to skip before returning results. Use with limit for pagination. Default 0. Example: offset=50.

filter_country

string

Limit results to one or more countries. Prefix with an operator: is, is_not. Accepts country names or codes. Example: filter_country=US,Canada or filter_country=is_not:France.

filter_region

string

Limit results by region or state. Example: filter_region=California.

filter_city

string

Limit results by city. Example: filter_city=San Francisco.

filter_device

string

Limit results by device type: desktop, mobile, or tablet. Example: filter_device=mobile.

filter_browser

string

Limit results by browser. Filtering Safari also includes Mobile Safari. Example: filter_browser=Chrome,Safari.

filter_os

string

Limit results by operating system. Example: filter_os=iOS,Android.

filter_referrer

string

Limit results by referrer domain or normalized source such as Google or Direct/None. Example: filter_referrer=Google.

filter_page

string

Limit results to visitors who viewed a page. Operators: is, is_not, contains, does_not_contain. Example: filter_page=contains:/docs.

filter_entry_page

string

Limit results by first page in the session. Same operators as filter_page. Example: filter_entry_page=/pricing.

filter_hostname

string

Limit results by tracked hostname. Example: filter_hostname=app.example.com.

filter_goal

string

Limit results to visitors who completed a goal. Example: filter_goal=signup.

filter_utm_source

string

Limit results by UTM source. Example: filter_utm_source=google.

filter_utm_medium

string

Limit results by UTM medium. Example: filter_utm_medium=cpc.

filter_utm_campaign

string

Limit results by UTM campaign. Example: filter_utm_campaign=launch.

filter_utm_term

string

Limit results by UTM term. Example: filter_utm_term=brand-keyword.

filter_utm_content

string

Limit results by UTM content. Example: filter_utm_content=hero-cta.

filter_ref

string

Limit results by the ref URL parameter. Example: filter_ref=twitter.

filter_source

string

Limit results by the source URL parameter. Example: filter_source=newsletter.

filter_via

string

Limit results by the via URL parameter. Example: filter_via=partner.

Example filters

Combine filter_* query params with date ranges:

GET /api/v1/analytics/timeseries?fields=visitors,revenue&interval=day&startAt=2026-05-01&endAt=2026-05-21&filter_device=mobile&filter_country=US

Operators: is, is_not, and contains (pages only). Full reference: filter your data.

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data (and pagination when the endpoint is paginated).

Response fields

data[].goal

string

Goal name for this analytics row. Use it to identify which custom action the row is measuring, such as signup or checkout_started.

data[].completions

number

Number of times this goal was completed. This counts events, so one visitor can contribute more than one completion.

data[].visitors

number

Number of unique visitors represented by this row or time bucket. Use it to compare traffic volume across dates, pages, sources, countries, devices, or campaigns.

pagination.limit

number

Maximum number of rows returned in one response. Use with offset to paginate through long result sets.

pagination.offset

number

Number of rows to skip before returning results. Use it with limit for pagination.

pagination.total

number

Total rows.

Authentication

df_ website API key: The website is inferred from the key. You do not need a websiteId query parameter.
dft_ account token: Requires analytics:read permission and ?websiteId= on every request. The token must be allowed to access that website.

Read authentication and scopes for token creation, permission lists, and scoped tokens.

Errors

400 — Invalid fields value or partial date range.

404 — Website not found.

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