Analytics

Get filter dropdown contents for the visitors page. Returns the top values per dimension with distinct visitor counts so the UI can render "Country — 1,234 visitors" rows. Each dimension is computed against the segment minus its own filter, so a selected value never collapses its own dropdown.

get/analytics/visitor-facets

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/analytics/visitor-facets
  • Auth: HTTP bearer

Query parameters

start_datestring required

Start date in format YYYY-MM-DD HH:MM:SS

end_datestring required

End date in format YYYY-MM-DD HH:MM:SS

project_idinteger required

Project ID or slug

environment_idinteger

Environment ID (optional)

include_crawlersboolean

Include crawlers (default: false)

has_activity_onlyboolean

Hide ghost visitors (default: true)

per_facet_limitinteger

Top N values per dimension (default: 50, max: 200)

filter_countrystring

Geolocation country

filter_regionstring

Geolocation region

filter_citystring

Geolocation city

filter_channelstring

First-touch channel

filter_referrerstring

First-touch referrer hostname (use 'Direct' for null)

Response

Top values per dimension

Changes

No recorded changes to this operation across all 53 revisions of this API.