Analyze

Get Top Dimensions Report

Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site

Query parameters

startTimestringRequiredformat: "date-time"
Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
endTimestringRequiredformat: "date-time"
Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
dimensionenumRequired
The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
metricScopeenumRequired
The unit each row's `count` is measured in — sessions or users.
Allowed values:
limitintegerOptional1-100Defaults to 25
Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
deviceTypeenumOptional
Restrict the report to a single device type.
Allowed values:
countrystringOptional=2 characters
Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
pagePathstringOptional
Restrict the report to a single page path.
trafficSourcestringOptional
Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
referrerstringOptional
Restrict the report to a single referrer domain.
browserstringOptional
Restrict the report to a single browser.
utmCampaignstringOptional
Restrict the report to a single `utm_campaign` value.
utmMediumstringOptional
Restrict the report to a single `utm_medium` value.
utmSourcestringOptional
Restrict the report to a single `utm_source` value.
filterobjectOptional
Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`). Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.

Response

Dimension values ranked by `count` for the requested window and filters.
reportenum
Discriminator identifying the report type.
windowobject

A reporting time window. endTime must be greater than startTime.

dimensionenum

The dimension whose top values are ranked.

  • country: ISO 3166-1 alpha-2 country code (e.g., US).
  • region: first-level subdivision below country, keyed by ISO 3166-2 code (e.g., US-CA, with name California, United States).
  • deviceType: desktop, mobile, or tablet.
  • os: operating system name (e.g., iOS, Windows NT).
  • browser: browser name (e.g., Chrome, Safari).
  • language: the visitor’s stated language preference (from the Accept-Language request header).
  • locale: the locale declared on the visited page (the page’s <html lang> value).
  • referrer: referrer domain (e.g., google.com).
  • trafficSource: traffic source category, keyed by a code: DN Direct, SP Paid Search, SO Organic Search, CP Paid Social, CO Organic Social, EM Email, RC Recirculation, OP Other Paid, OT Other, AI Generative AI. attributeKey is the code; name is the label.
  • utmCampaign: utm_campaign value.
  • utmContent: utm_content value.
  • utmMedium: utm_medium value.
  • utmSource: utm_source value.
  • utmTerm: utm_term value.
  • audienceIds: Webflow audience identifier. For this dimension, attributeKey is the audience ID and name is the audience’s display name (falling back to the ID if no display name is set).
metricScopeenum

The unit each row’s count is measured in.

  • session: number of sessions attributed to the dimension value.
  • user: number of unique users attributed to the dimension value.
limitinteger1-100

The row cap that was applied to this response (echoes the resolved request value, including the default).

datalist of objects

Dimension values ranked by count, descending. At most limit rows.

filterobjectOptional

Filter the top dimensions report by dimension. Each property is an optional set of AnalyzeFilterOperators (eq, in, ne, nin) applied to the named dimension. Filter a given dimension in one place — either inside filter or as a top-level query parameter.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error