Widgets

Widget statistics per widget

Event counts per widget, in one of two ways.

With widget_ids (up to 100, from list_widgets): every listed live widget of the site in the order given, zeros without events; repeated ids count once, unknown, deleted and foreign ids are left out. The period is optional here: without from and to the numbers cover the whole life, and period is null.

Without widget_ids the period is required: the live widgets with events in the period, most shown first. Deleted widgets and events without a widget are left out, so the sum may be below get_widgets_stats.

folder_id, is_active, layout and search narrow either way to the widgets that match every one given, and then every matched widget is listed, zero ones too: one call gives the numbers of a folder or of the active widgets. total is the sum of the listed widgets; use it rather than adding the items up.

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/by-widget

Request

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

Path parameters

site_idinteger required

Query parameters

widget_idsinteger[]

Widget ids from list_widgets, up to 100; repeat for several. With them the period is optional

fromstring date

UTC day, included; omit for the whole life

tostring date

UTC day, included; with from, today when omitted

is_activeboolean

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

layout'modal' | 'bar' | 'panel' | 'slide_in' | 'sidebar' | 'fullscreen' | 'inline'

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

Changes

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