---
title: "Shared event audience"
method: GET
path: "/api/share/{token}/sites/{id}/events/audience"
tags: ["Share"]
---

# Shared event audience

`GET /api/share/{token}/sites/{id}/events/audience`

## Request

- Base URL: `https://demo.hitkeep.com`
- URL: `https://demo.hitkeep.com/api/share/{token}/sites/{id}/events/audience`
- Auth: none declared

Returns event audience through share token, including aggregate pages, referrers, devices, countries, cities, providers, and ASNs. Optional property filters and repeatable filter=type:value hit-dimension filters restrict the sessions included.

## Path parameters

- `token` string, required
- `id` string, uuid, required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `event_name` string, required
- `property_key` string
- `property_value` string
- `filter` string
- `dimension_key` 'path' | 'hostname' | 'referrer' | 'referrer_host' | 'device' | 'country' | 'city' | 'provider' | 'asn' | 'browser' | 'language' | 'utm_campaign' | 'utm_content' | 'utm_medium' | 'utm_source' | 'utm_term'
- `dimension_value` string

## Response `200`

Event audience

- EventAudience
  - `imported_excluded` ImportExclusionReason[]
    - `detail` string
    - `reason` string
  - `top_asns` MetricStat[]
    - `name` string
    - `value` integer
  - `top_cities` MetricStat[]
    - `name` string
    - `value` integer
  - `top_countries` MetricStat[]
    - `name` string
    - `value` integer
  - `top_devices` MetricStat[]
    - `name` string
    - `value` integer
  - `top_pages` MetricStat[]
    - `name` string
    - `value` integer
  - `top_providers` MetricStat[]
    - `name` string
    - `value` integer
  - `top_referrers` MetricStat[]
    - `name` string
    - `value` integer

---

[API](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api.md) · [All operations](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/revisions/bb2df36ab2a4?raw)