Widgets

Diagnose widgets

Why widgets do not show: the first call for "my widget is not showing", "it shows on the wrong pages" or "I get no responses". Without widget_id it checks the site (served at all, our code installed, any widget on) and gives one short row per active widget with its worst cause; with widget_id it checks that widget in the order visitors meet it: on and published, A/B test, schedule, targeting, stop rules, trigger, whether answers are sent, and where it showed. Views are the shows Widget statistics count. Each check has a stable reason code, what to do (next_action), who can do it (who) and facts in values; read who before promising anything.

It reads the saved widget, as visitors get it, and changes nothing. Views are facts, not proof that the current settings show: install is unknown when nothing proves the code either way. At most the 100 newest active widgets are checked. The meaning of every code and how to word it: the guide widgets.diagnostics.read.

get/v1/sites/{site_id}/widgets/diagnostics

Request

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

Path parameters

site_idinteger required

Query parameters

widget_idinteger

A widget id from List widgets, to check it whole

Response

Successful Response

state'ok' | 'warning' | 'blocking' | 'unknown' required

ok: nothing found. warning: some visitors, pages, times or widgets do not get it, or a likely mistake. blocking: no visitor gets it. unknown: the source or the rules could not be read, or (install) nothing proves it either way.

Changes

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