Sign in

v13

OpenAPI 3.0.32026-07-31359869.4 MB
web-analytics

Aggregates page views

Counts pageviews on a project, within the requested date range. Results are either aggregated or broken down over time. Results can additionally be broken down by one dimension, and filtered by multiple dimensions.

get/v1/query/web-analytics/visits/aggregate

Query parameters

projectIdstring required

The project identifier or the project name

Example:prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA

The project identifier or the project name

Up to two dimensions used to break down results.

At most one time granularity is allowed: hour, day, week, month, year.

Other dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.

JSON dimensions: flags. Used bare, it breaks down results by key, for example flags returns one group per flag name. With a key, it breaks down results by that key's value, for example flags/beta_banner. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag'.

[
  "day",
  "country"
]
number required
OR
string required

Timestamp in milliseconds, or a valid Date string.

Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.

number required
OR
string required

Timestamp in milliseconds, or a valid Date string.

Selects data until (including) this date. Will be adjusted according to the desired time granularity.

limitinteger

Number of distinct results, default to 10. Other results are grouped into "Others" group.

Example:3

Number of distinct results, default to 10. Other results are grouped into "Others" group.

filterstring

OData-compliant filter. Encode the value when sending it in a URL.

Allows filtering on one or multiple dimensions. By default, filters for production environment only.

Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.

JSON dimensions filtered by key: flags/<name>, for example flags/beta_banner eq 'true'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'.

Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.

Example:requestPath eq '/docs'

OData-compliant filter. Encode the value when sending it in a URL.

Allows filtering on one or multiple dimensions. By default, filters for production environment only.

Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.

JSON dimensions filtered by key: flags/<name>, for example flags/beta_banner eq 'true'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'.

Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

versionnumber required