Get ecommerce summary

GET

/api/sites/{id}/ecommerce

curl --request GET \
  --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ecommerce \
  --cookie hk_token=<hk_token>

Returns revenue, orders, average order value, checkout starts, and checkout conversion for a site.

Authorizations

• cookieAuth
• bearerAuth
• 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, browser, language, utm_campaign, utm_content, utm_medium, utm_source, utm_term.

filter_type

string

filter_value

string

item_id

string

item_name

string

Responses

200

Ecommerce summary

Media type application/json

object

average_order_value

number

checkout_conversion_rate

number

checkout_starts

integer

currency

string

orders

integer

revenue

number

Example ^generated

{
  "average_order_value": 1,
  "checkout_conversion_rate": 1,
  "checkout_starts": 1,
  "currency": "example",
  "orders": 1,
  "revenue": 1
}