Widgets

Widget statistics over time

Event counts of one widget, split into buckets. Buckets are consecutive days, calendar weeks (Monday to Sunday) or calendar months; the first and the last are cut to the period. Every bucket is present, an empty one with zeros. 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.

get/v1/sites/{site_id}/widgets/{widget_id}/stats/timeline

Request

Base URL
https://api.getsitecontrol.com
Auth
HTTP bearer

Path parameters

site_idinteger required

widget_idinteger required

Widget id from List widgets

Query parameters

interval'day' | 'week' | 'month'

day, calendar week (Monday to Sunday) or calendar month.

Bucket length

fromstring date required

First day of the period, UTC, included

tostring date

Last day of the period, UTC, included; today when omitted

Response

Successful Response

matchedinteger 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

interval'day' | 'week' | 'month' required