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

# Get ecommerce sources REST API

GET

/api/sites/{id}/ecommerce/sources

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ecommerce/sources';
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/ecommerce/sources \
  --cookie hk_token=<hk_token>
```

-

Returns revenue and order counts grouped by UTM source, medium, campaign, and referrer.

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

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

**filter_type**

string

**filter_value**

string

**item_id**

string

**item_name**

string

**limit**

integer

>= 1 <= 100

## Responses

### 200

Ecommerce sources

application/json

Array<object>

object

**orders**

integer

**referrer**

string

**revenue**

number

**utm_campaign**

string

**utm_medium**

string

**utm_source**

string

##### Examplegenerated

```
[
  {
    "orders": 1,
    "referrer": "example",
    "revenue": 1,
    "utm_campaign": "example",
    "utm_medium": "example",
    "utm_source": "example"
  }
]
```

[Previous Get top ecommerce products](https://hitkeep.com/api/operations/apisitesidecommerceproducts/)[Next Get ecommerce timeseries](https://hitkeep.com/api/operations/apisitesidecommercetimeseries/)