Get Overview

GET/v1/stores/{store_id}/analytics/overviewScope analytics:read

Scope: analytics:read (scopes and plan access)
Rate limit: 600 requests/min per API key (test keys: 60/min) (rate limits)

`{ period; currency; metrics; previous }` (formulas 03 §6.12).

Parameters

Parameters of Get Overview
Name	In	Type	Description
store_idrequired	path	string
fromrequired	query	string	Store-local date, inclusive
torequired	query	string	Store-local date, inclusive
compare	query	"previous_period" \| null

Example request

curl -X GET "https://api.shopassist.coec.dk/v1/stores/sto_01j8000000e008000000000000/analytics/overview" \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"

Response 200 (AnalyticsOverview)

Response of Get Overview
Field	Type	Description
currencyrequired	string	pattern `^[A-Z]{3}$`
metricsrequired	Metrics	`Metrics` (03 §6.12; sums over `daily_store_metrics`; rates `null` when the denominator is 0).
metrics.add_to_cartrequired	integer
metrics.ai_repliesrequired	integer
metrics.answers_rated_downrequired	integer
metrics.answers_rated_uprequired	integer
metrics.attributed_ordersrequired	integer
metrics.attribution_coveragerequired	number \| null	conversations_consented / conversations
metrics.billable_unitsrequired	integer
metrics.chat_conversion_raterequired	number \| null	attributed_orders_consented / conversations_consented
metrics.checkout_clicksrequired	integer
metrics.conversationsrequired	integer
metrics.csat_avgrequired	number \| null	csat_sum / csat_count
metrics.csat_countrequired	integer
metrics.handoff_raterequired	number \| null	handoffs / conversations
metrics.leadsrequired	integer
metrics.proactive_ctrrequired	number \| null	proactive_clicked / proactive_shown
metrics.resolution_raterequired	number \| null	resolved_ai / conversations
metrics.revenue_by_typerequired	RevenueByType	Three labelled amounts, never summed (D-119).
metrics.revenue_by_type.assisted_sessionrequired	Money	Σ total_amount of assisted_session orders
metrics.revenue_by_type.assisted_session.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
metrics.revenue_by_type.assisted_session.currencyrequired	string	pattern `^[A-Z]{3}$`
metrics.revenue_by_type.bot_add_to_cartrequired	Money	Σ assisted_amount of bot_add_to_cart orders
metrics.revenue_by_type.bot_add_to_cart.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
metrics.revenue_by_type.bot_add_to_cart.currencyrequired	string	pattern `^[A-Z]{3}$`
metrics.revenue_by_type.bot_checkout_linkrequired	Money	Σ total_amount of bot_checkout_link orders
metrics.revenue_by_type.bot_checkout_link.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
metrics.revenue_by_type.bot_checkout_link.currencyrequired	string	pattern `^[A-Z]{3}$`
metrics.widget_opensrequired	integer
periodrequired	AnalyticsPeriod	`{ from; to }` (store-local dates).
period.fromrequired	string	format date
period.torequired	string	format date
previousrequired	Metrics \| null
previous.add_to_cartrequired	integer
previous.ai_repliesrequired	integer
previous.answers_rated_downrequired	integer
previous.answers_rated_uprequired	integer
previous.attributed_ordersrequired	integer
previous.attribution_coveragerequired	number \| null	conversations_consented / conversations
previous.billable_unitsrequired	integer
previous.chat_conversion_raterequired	number \| null	attributed_orders_consented / conversations_consented
previous.checkout_clicksrequired	integer
previous.conversationsrequired	integer
previous.csat_avgrequired	number \| null	csat_sum / csat_count
previous.csat_countrequired	integer
previous.handoff_raterequired	number \| null	handoffs / conversations
previous.leadsrequired	integer
previous.proactive_ctrrequired	number \| null	proactive_clicked / proactive_shown
previous.resolution_raterequired	number \| null	resolved_ai / conversations
previous.revenue_by_typerequired	RevenueByType	Three labelled amounts, never summed (D-119).
previous.revenue_by_type.assisted_sessionrequired	Money	Σ total_amount of assisted_session orders
previous.revenue_by_type.assisted_session.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
previous.revenue_by_type.assisted_session.currencyrequired	string	pattern `^[A-Z]{3}$`
previous.revenue_by_type.bot_add_to_cartrequired	Money	Σ assisted_amount of bot_add_to_cart orders
previous.revenue_by_type.bot_add_to_cart.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
previous.revenue_by_type.bot_add_to_cart.currencyrequired	string	pattern `^[A-Z]{3}$`
previous.revenue_by_type.bot_checkout_linkrequired	Money	Σ total_amount of bot_checkout_link orders
previous.revenue_by_type.bot_checkout_link.amountrequired	string	pattern `^-?\d+(\.\d{1,6})?$`
previous.revenue_by_type.bot_checkout_link.currencyrequired	string	pattern `^[A-Z]{3}$`
previous.widget_opensrequired	integer

{
  "currency": "DKK",
  "metrics": {
    "add_to_cart": 1,
    "ai_replies": 1,
    "answers_rated_down": 1,
    "answers_rated_up": 1,
    "attributed_orders": 1,
    "attribution_coverage": 1,
    "billable_units": 1,
    "chat_conversion_rate": 1,
    "checkout_clicks": 1,
    "conversations": 1,
    "csat_avg": 1,
    "csat_count": 1,
    "handoff_rate": 1,
    "leads": 1,
    "proactive_ctr": 1,
    "resolution_rate": 1,
    "revenue_by_type": {
      "assisted_session": {
        "amount": "499.95",
        "currency": "DKK"
      },
      "bot_add_to_cart": {
        "amount": "499.95",
        "currency": "DKK"
      },
      "bot_checkout_link": {
        "amount": "499.95",
        "currency": "DKK"
      }
    },
    "widget_opens": 1
  },
  "period": {
    "from": "2026-10-01",
    "to": "2026-10-01"
  },
  "previous": {
    "add_to_cart": 1,
    "ai_replies": 1,
    "answers_rated_down": 1,
    "answers_rated_up": 1,
    "attributed_orders": 1,
    "attribution_coverage": 1,
    "billable_units": 1,
    "chat_conversion_rate": 1,
    "checkout_clicks": 1,
    "conversations": 1,
    "csat_avg": 1,
    "csat_count": 1,
    "handoff_rate": 1,
    "leads": 1,
    "proactive_ctr": 1,
    "resolution_rate": 1,
    "revenue_by_type": {
      "assisted_session": {
        "amount": "499.95",
        "currency": "DKK"
      },
      "bot_add_to_cart": {
        "amount": "499.95",
        "currency": "DKK"
      },
      "bot_checkout_link": {
        "amount": "499.95",
        "currency": "DKK"
      }
    },
    "widget_opens": 1
  }
}

Errors

Every error uses the error envelope; the code field is stable.

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
422 Unprocessable Content
429 Too Many Requests