Media Item — Impression

The LiSA Player sends a media item impression message to indicate that a media item has been loaded and displayed in the player..

Properties

Along with all standard Media Item message properties, an Impression message includes the following additional properties:

Name	Type	Description
auxiliaryData	AuxiliaryData Required.	The auxiliaryData property is an object that holds additional metadata related to the media item impression. Please refer to AuxiliaryData for detailed information.
messageType	Literal Required.	lsc:media:impression

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name	Type	Description
action	Literal Required.	ready ⚠️ Please use messageType instead.
products	Object Optional.	The products field specifies a map of product identifiers, where each key represents the external or merchant-specific identifier for the product and its corresponding value represents the LiSA internal product identifier. ⚠️ Please use auxiliaryData.products instead.
target	Literal Required.	show ⚠️ Please use messageType instead.

---

Type Definition

interface MediaItemImpressionMessage extends Omit<
  MediaItemMessage,
  'messageType'
> {
  auxiliaryData: MediaItemImpressionAuxiliaryData;
  messageType: 'lsc:media:impression';
}

MediaItemImpressionAuxiliaryData

Name	Type	Description
products	Object Required.	The products field specifies a map of product identifiers, where each key represents the external or merchant-specific identifier for the product and its corresponding value represents the LiSA internal product identifier.

interface MediaItemImpressionAuxiliaryData {
  products: Record<string, string>;
}

Examples

{
  "auxiliaryData": {
    "products": {
      "9caf4704-ec2f-438b-8b18-128a9ba22fda": "6052b475-b887-4d84-8f83-7797c7790dbd"
    }
  },
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:media:impression",
  "progress": {
    "bufferedTimeInMs": 636036,
    "currentTimeInMs": 619609,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 22761,
    "isLive": true,
    "isPlaying": true,
    "skipTimeInMs": 600000,
    "visitorDwellTimeInMs": 23882
  },
  "sender": "LiSA",
  
  "action": "ready",
  "additional":  {
    "showDate": "2025-01-15T18:00:00.000Z",
    "showId": "9f333331-45cb-4289-8bcd-9023c1871111",
    "showState": "live",
    "showTitle": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️"
  },
  "products": {
    "9caf4704-ec2f-438b-8b18-128a9ba22fda": "6052b475-b887-4d84-8f83-7797c7790dbd"
  },
  "target": "show"
}