type parameter to select the dimension you want — for example path for top pages, country for visitor geography, or utmSource for campaign sources. The response is an array of {x, y} objects sorted from highest to lowest count, making it straightforward to render leaderboard tables or bar charts.
GET /api/websites/{websiteId}/metrics
Request
Headers
Path Parameters
Query Parameters
Required
The dimension to rank. Accepted values:
path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.Date Range
Pagination & Search
Filters
Response
200 – Success Returns an array of ranked rows, sorted byy (count) in descending order.
The dimension value, e.g.
"/blog/my-post" for type=path, or "US" for type=country. null when the dimension value is unknown.The count for this dimension value. For activity dimensions (
path, event, etc.) this is pageviews or event fires. For visitor dimensions (country, browser, os, etc.) this is unique visitors.200 Response