---
title: "Get ecommerce summary"
method: GET
path: "/api/sites/{id}/ecommerce"
tags: ["Sites"]
---

# Get ecommerce summary

`GET /api/sites/{id}/ecommerce`

## Request

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

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

## Path parameters

- `id` string, uuid, required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `filter` string
- `filter_type` string
- `filter_value` string
- `item_id` string
- `item_name` string

## Response `200`

Ecommerce summary

- EcommerceSummary
  - `average_order_value` number
  - `checkout_conversion_rate` number
  - `checkout_starts` integer
  - `currency` string
  - `orders` integer
  - `revenue` number
  - `top_asns` MetricStat[]
    - `name` string
    - `value` integer
  - `top_cities` MetricStat[]
    - `name` string
    - `value` integer
  - `top_providers` 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)