DataFast logoDataFast
"Best analytics tool I've used in 14 years"

Get overview

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

Return aggregate analytics metrics for a date range or all time — visitors, sessions, bounce rate, revenue, and conversion rate in one request. This mirrors the headline numbers on your DataFast dashboard.

Omit startAt and endAt to query all-time data. Use fields to request only the metrics your integration needs.

New/returning visitor fields use tracker session metadata collected after the rollout; old or cookieless events are not reliably classifiable.

Request

Query parameters

fields
string
Controls which properties are included in the response. Use it to request only the metrics or metadata your integration needs. Comma-separated response columns. Omit to return all valid fields for this endpoint. Valid: visitors, new_visitors, returning_visitors, visitor_breakdown, pageviews, sessions, bounce_rate, avg_session_duration, currency, revenue, payments, revenue_per_visitor, conversion_rate. Returns all when omitted.
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.
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_visit_count
number
Limit results by the all-time visitor session count tracked by the browser cookie. Operators: is, is_not, gte, lte. Example: filter_visit_count=gte:2 for returning visitors.
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, contains (pages only), and gte/lte for filter_visit_count. 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[].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. Total unique visitors in the selected period and filters.
data[].new_visitors
number
Visitors whose tracked session number is less than 2.
data[].returning_visitors
number
Visitors whose tracked session number is 2 or higher.
data[].visitorBreakdown
object
New/returning visitor counts and percentages.
data[].pageviews
number
Total pageviews in the selected period and filters.
data[].sessions
number
Number of sessions represented by this row or time bucket. A visitor can create multiple sessions, so this can be higher than visitors. Total sessions in the selected period. One visitor can create multiple sessions.
data[].bounce_rate
number
Percentage of sessions that ended without another tracked interaction. Use it to spot low-engagement traffic.
data[].avg_session_duration
number
Average session duration for the selected period. Average session duration for the selected period.
data[].currency
string
Currency code for money values, such as USD or EUR.
data[].revenue
number
Revenue attributed to this row or time bucket, in the website currency. Use it to see which time periods or dimensions influenced paid conversions. Total attributed revenue for the selected period and filters.
data[].payments
number
Number of payment events attributed to this row or time bucket. Use it when you need transaction count instead of revenue amount. Total payment events for the selected period and filters.
data[].revenue_per_visitor
number
Average revenue per visitor. Use it to compare traffic quality across segments.
data[].conversion_rate
number
Revenue-based conversion rate for this row or bucket. Use it to compare how efficiently traffic converts. Payment conversion rate for the selected period and filters.

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, partial date range, or invalid filter.

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

Example request
curl -X GET "https://datafa.st/api/v1/analytics/overview?startAt=2026-05-01&endAt=2026-05-19" \
  -H "Authorization: Bearer df_xxx"
Success response
{
  "status": "success",
  "data": [{
    "visitors": 12450,
    "new_visitors": 3840,
    "returning_visitors": 8610,
    "visitorBreakdown": {
      "new": 3840,
      "returning": 8610,
      "newPercentage": 30.84,
      "returningPercentage": 69.16
    },
    "pageviews": 16890,
    "sessions": 16890,
    "bounce_rate": 42.1,
    "avg_session_duration": 68,
    "currency": "USD",
    "revenue": 28450,
    "payments": 328,
    "revenue_per_visitor": 2.29,
    "conversion_rate": 2.63
  }]
}
PreviousAPI reference / Time SeriesNextAPI reference / Metadata