---
title: "Get event audience REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get event audience, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apisitesideventsaudience/"
---

# Get event audience REST API

GET

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

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/audience?event_name=example&dimension_key=path';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/audience?event_name=example&dimension_key=path' \
  --cookie hk_token=<hk_token>
```

-

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.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**
- **[bearerAuth](https://hitkeep.com/api/#bearerauth)**
- **[apiKeyAuth](https://hitkeep.com/api/#apikeyauth)**

## Parameters

### Path Parameters

**id**

required

string format: uuid

### Query Parameters

**from**

string format: date-time

**to**

string format: date-time

**event_name**

required

string

**property_key**

string

**property_value**

string

**filter**

string

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**

deprecated

string

Allowed values: 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_value**

deprecated

string

Deprecated single event dimension value. Requires dimension_key.

## Responses

### 200

Event audience

application/json

object

**imported_excluded**

Array<object>

object

**detail**

string

**reason**

string

**top_asns**

Array<object>

object

**name**

string

**value**

integer

**top_cities**

Array<object>

object

**name**

string

**value**

integer

**top_countries**

Array<object>

object

**name**

string

**value**

integer

**top_devices**

Array<object>

object

**name**

string

**value**

integer

**top_pages**

Array<object>

object

**name**

string

**value**

integer

**top_providers**

Array<object>

object

**name**

string

**value**

integer

**top_referrers**

Array<object>

object

**name**

string

**value**

integer

##### Examplegenerated

```
{
  "imported_excluded": [
    {
      "detail": "example",
      "reason": "example"
    }
  ],
  "top_asns": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_cities": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_countries": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_devices": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_pages": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_providers": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_referrers": [
    {
      "name": "example",
      "value": 1
    }
  ]
}
```

[Previous Get ecommerce timeseries](https://hitkeep.com/api/operations/apisitesidecommercetimeseries/)[Next Get event property breakdown](https://hitkeep.com/api/operations/apisitesideventsbreakdown/)