---
title: "Widget statistics"
method: GET
path: "/v1/sites/{site_id}/widgets/{widget_id}/stats"
tags: ["Widgets"]
---

# Widget statistics

`GET /v1/sites/{site_id}/widgets/{widget_id}/stats`

## Request

- Base URL: `https://api.getsitecontrol.com`
- URL: `https://api.getsitecontrol.com/v1/sites/{site_id}/widgets/{widget_id}/stats`
- Auth: HTTP bearer

Event counts of one widget over the period. Counts: `show` is the widget shown to a visitor (a view), `submit` a form sent, `openUrl` a button or link opening a URL, `showWidget` a button opening another widget, `addToCart`, `applyCoupon` and `copyToClipboard` the matching cart and coupon buttons. `rates` next to each `total` gives every action counter divided by `show`, rounded to 4 places (`rates.submit` is the conversion rate); a rate is null when `show` is 0, as it is undefined, not zero.

## Path parameters

- `site_id` integer, required
- `widget_id` integer, required: Widget id from List widgets

## Query parameters

- `from` string, date, required: First day of the period, UTC, included
- `to` string, date: Last day of the period, UTC, included; today when omitted

## Response `200`

Successful Response

- WidgetStatsTotal
  - `period` StatsPeriod, required
    - `date_from` string, date, required: First day, UTC, included
    - `date_to` string, date, required: Last day, UTC, included
  - `matched` integer, nullable: How many live widgets the filters or ids matched; null without them. 0 means nothing matched, not that nothing happened: check the filters or ids
  - `total` WidgetMetrics, required: Event counts keyed by event type; every key is always present.
    - `show` integer, required
    - `submit` integer, required
    - `openUrl` integer, required
    - `showWidget` integer, required
    - `addToCart` integer, required
    - `applyCoupon` integer, required
    - `copyToClipboard` integer, required
  - `rates` WidgetRates, required: Every action counter of `total` as a share of `show`. A fraction rounded to 4 places: 0.0125 is 1.25%. The counters are events, not people, each dated on its own: a visitor may act more than once per show, and an action in the period may follow a show before it, so a rate can exceed 1.
    - `submit` number, nullable: `submit` / `show`; null when there were no shows: the rate is undefined, not zero
    - `openUrl` number, nullable: `openUrl` / `show`; null when there were no shows: the rate is undefined, not zero
    - `showWidget` number, nullable: `showWidget` / `show`; null when there were no shows: the rate is undefined, not zero
    - `addToCart` number, nullable: `addToCart` / `show`; null when there were no shows: the rate is undefined, not zero
    - `applyCoupon` number, nullable: `applyCoupon` / `show`; null when there were no shows: the rate is undefined, not zero
    - `copyToClipboard` number, nullable: `copyToClipboard` / `show`; null when there were no shows: the rate is undefined, not zero

## Other responses

- `400`: Unsupported GSC-Version
- `401`: Missing or invalid API key or access token
- `403`: Access denied
- `404`: Not found
- `422`: Validation failed
- `429`: Rate limited
- `503`: `temporarily_unavailable`: the statistics store timed out or is overloaded; the heavy request is spent all the same

---

[API](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api.md) - [All operations](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/revisions/084fcad80e75?raw)