Widgets

Site widget statistics over time

Event counts of all widgets of the site, split into buckets. widget_ids, folder_id, is_active, layout and search narrow the count to the live widgets that match every one given; matched says how many, and matched: 0 means no widget matched. 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/stats/timeline

Request

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

Path parameters

site_idinteger required

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

widget_idsinteger[]

Only these widget ids from list_widgets, up to 100; repeat for several

is_activeboolean

true: only widgets that are on; false: only off

Where the widget sits on the page, named as in the admin. modal: a window centred over the page. bar: a strip across the top or bottom of the page. panel: a box attached to the bottom of the screen, opened from its header. slide_in: a box that slides in from a corner. sidebar: a panel attached to the left or right edge of the screen. fullscreen: covers the whole screen. inline: placed inside the page content. "Pop-up" is not a layout: users call any widget a pop-up.

Only widgets of this layout; use it only when the user names one

searchstring

Words of the name in order (case, spacing and punctuation are ignored), the id, or words of the widget's own text

folder_idinteger

Only the items of this folder, an id from list_folders; 0 is General

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