web-analytics

Aggregates custom events

Changed on

Counts custom events 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/events/aggregate

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/query/web-analytics/events/aggregate
  • Auth: HTTP bearer

Query parameters

projectIdstring required

The project identifier or the project name

Example:prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA
[
  "day",
  "eventName"
]
number required
OR
string required
number required
OR
string required
limitinteger

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

Example:3
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, eventName.

JSON dimensions filtered by key: flags/<name>, eventData/<property>, for example eventData/plan eq 'pro'. 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:eventData/plan eq 'pro'
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

Changes

  • 5a120284f519Revision changes
    • breaking

      added subschema #1 subschema #2 to the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

  • 2c463a1d98b1Revision changes
    • warning

      for the query request parameter filter, the maxLength was set to 2048