Widget Events

9min

If you are creating your own widgets or components that rely on data fetched from LiSA APIs, it is important to implement a similar event flow to enable tracking in your analytics tool.
All widget events append identical properties to the foundational properties inherited from the analytics event.
Name
Description
widgetConfigurationId
The identifier associated with the applied widget configuration.
widgetName
The distinct name assigned to your widget.
Schema
Example
TypeScript
export type WidgetEvent = AnalyticsEvent & {
  widgetConfigurationId: string;
  widgetName: string;
};
export type WidgetEvent = AnalyticsEvent & {
  widgetConfigurationId: string;
  widgetName: string;
};
﻿
JSON
{
  "client": "lisa",
  "eventDate": "2021-06-23T10:15:00.000Z",
  "name": "lsc:widget:init",
  "visitorId": "fa0d5c44-9e40-4f1e-92d4-ebffcbd4f1df",
  "visitorDeviceType": "mobile",
  "widgetConfigurationId": "default",
  "widgetName": "stories-badges"
}
{
  "client": "lisa",
  "eventDate": "2021-06-23T10:15:00.000Z",
  "name": "lsc:widget:init",
  "visitorId": "fa0d5c44-9e40-4f1e-92d4-ebffcbd4f1df",
  "visitorDeviceType": "mobile",
  "widgetConfigurationId": "default",
  "widgetName": "stories-badges"
}
﻿
To improve simplicity and readability, the subsequent examples of specific event types exclude the foundational properties inherited from the analytics and widget event.
Widget Event Types
If an event includes extra properties, the schema and example for each property are specified with the event.
lsc:widget:error
Sent when an error occurs and the widget is unable to be displayed.
Schema
Example
TypeScript
export type WidgetErrorEvent = {
  message: string;
};
export type WidgetErrorEvent = {
  message: string;
};
﻿
JSON
{
  "message": "Unable to fetch widget contents."
}
{
  "message": "Unable to fetch widget contents."
}
﻿
lsc:widget:init
Sent when the widget begins its initialization process.
lsc:widget:item-click
Sent when a viewer interacts by clicking or tapping on a widget item.
Name
Description
itemType
The distinct type of widget item.
itemSourceId
The identifier associated with the widget item's source.
itemSourceType
The distinct type of a widget item's source.
Schema
Example
TypeScript
export type WidgetItemClickEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
export type WidgetItemClickEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
﻿
﻿
JSON
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
﻿
lsc:widget:item-impression
Sent when a widget item becomes visible in the viewport for the first time, with at least 90% of it being displayed.
Name
Description
itemType
The distinct type of widget item.
itemSourceId
The identifier associated with the widget item's source.
itemSourceType
The distinct type of a widget item's source.
Schema
Example
TypeScript
export type WidgetItemImpressionEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
export type WidgetItemImpressionEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
﻿
JSON
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
﻿
lsc:widget:item-like
Sent when a viewer interacts by clicking or tapping a widget item's like CTA.
Schema
Example
TypeScript
export type WidgetItemLikeEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
export type WidgetItemLikeEvent = {
  itemType: 'badge';
  itemSourceId: string;
  itemSourceType: 'creator' | 'show' | 'story';
};
﻿
JSON
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
{
  "itemType": "badge",
  "itemSourceId": "0cd8ca4a-bc85-47fa-bffd-cb5890dbb027",
  "itemSourceType": "creator"
}
﻿
lsc:widget:ready
Sent once the widget content API response has been successfully fetched and the widget has finished rendering.

Name	Description
widgetConfigurationId	The identifier associated with the applied widget configuration.
widgetName	The distinct name assigned to your widget.

Name	Description
itemType	The distinct type of widget item.
itemSourceId	The identifier associated with the widget item's source.
itemSourceType	The distinct type of a widget item's source.

Name	Description
itemType	The distinct type of widget item.
itemSourceId	The identifier associated with the widget item's source.
itemSourceType	The distinct type of a widget item's source.

Updated 25 Mar 2024

Did this page help you?

Analytics Event Reference

Media Player Events