The widget response object
You can get a widget JSON object in the Sitecore Discover Search and Recommendation response if you sent a widget object in the request. The object contains the same information and identifiers in your request. This makes it easier to see which widget_id and rfkid the response generates. In addition, if you have a running experiment, the widget object also contains the experiment details.
The following shows the basic structure of the widget object in a response:
Keys
Keys
Depending on your request you may see some or all response keys.
The following table describes the keys in the widget response object:
| Key | Type | Description | Values |
|---|---|---|---|
| rfkid | string | Discover ID associated with the widget.This is copied from rfkid in your request. | n/a |
| widget_id | string | Unique ID string assigned to a widget by Sitecore Discover.Discover gets this from the request widget_id. | n/a |
| variation_id | string | Unique identifier for the variation applied to the response.NoteYou can define the variation (group of behaviors or rules) for a widget in the Customer Engagement Console (CEC). | n/a |
| experiment_id | string | Unique ID string for the split test or experiment entity that the response belongs to. You see this only when an experiment is running.NoteYou can define split tests in the CEC. | n/a |
| experiment_bucket | string | Unique, non-human-readable generated ID for the running experiment's bucket that the response belongs to. You see an experiment_bucket only when an experiment is running. | n/a |
| type | string | Widget type that Discover defines. | preview_searchcontent_gridrecommendationbannerhtml_block |
If you have suggestions for improving this article, let us know!