Sites

Get event audience

Returns top pages, referrers, devices, countries, cities, providers, and ASNs for sessions containing the selected event. Optional property filters and repeatable filter=type:value hit-dimension filters restrict the sessions included.

get/api/sites/{id}/events/audience

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/events/audience
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Query parameters

fromstring date-time
tostring date-time
event_namestring required
property_keystring
property_valuestring
filterstring

Filter in form type:value (repeatable). Supported types: path, hostname, referrer, referrer_host, device, country, city, provider, asn, browser, language, ai_bot, ai_bot_category, ai_source, utm_campaign, utm_content, utm_medium, utm_source, utm_term, qr_code_id.

dimension_key'path' | 'hostname' | 'referrer' | 'referrer_host' | 'device' | 'country' | 'city' | 'provider' | 'asn' | 'browser' | 'language' | 'utm_campaign' | 'utm_content' | 'utm_medium' | 'utm_source' | 'utm_term'

Deprecated single event dimension filter. Prefer repeatable filter=type:value.

dimension_valuestring

Deprecated single event dimension value. Requires dimension_key.

Response

Event audience

Changes

No recorded changes to this operation across all 1 revision of this API.