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

# Get ecommerce summary REST API

GET

/api/sites/{id}/ecommerce

FetchcURL

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

-

Returns revenue, orders, average order value, checkout starts, checkout conversion, and aggregate city, provider, and ASN breakdowns for a site.

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

## Responses

### 200

Ecommerce summary

application/json

object

**average_order_value**

number

**checkout_conversion_rate**

number

**checkout_starts**

integer

**currency**

string

**orders**

integer

**revenue**

number

**top_asns**

Array<object>

object

**name**

string

**value**

integer

**top_cities**

Array<object>

object

**name**

string

**value**

integer

**top_providers**

Array<object>

object

**name**

string

**value**

integer

##### Examplegenerated

```
{
  "average_order_value": 1,
  "checkout_conversion_rate": 1,
  "checkout_starts": 1,
  "currency": "example",
  "orders": 1,
  "revenue": 1,
  "top_asns": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_cities": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_providers": [
    {
      "name": "example",
      "value": 1
    }
  ]
}
```

[Previous Rename site domain](https://hitkeep.com/api/operations/apisitesiddomain/)[Next Get top ecommerce products](https://hitkeep.com/api/operations/apisitesidecommerceproducts/)