Sites

Get ecommerce summary

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

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

Path parameters

idstring uuid required

Query parameters

fromstring date-time
tostring date-time
filterstring

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_typestring
filter_valuestring
item_idstring
item_namestring

Response

Ecommerce summary

average_order_valuenumber
checkout_conversion_ratenumber
checkout_startsinteger
currencystring
ordersinteger
revenuenumber

Changes

No recorded changes to this operation across all 1 revision of this API.