Skip to main content

Player metrics

The below events are emitted by the Lora Short Video, for the purpose of reporting metrics.

All events and interactions are listed further down.

Listening to events​

By registering an event listener on the top window of the page that you have the short video, all short video events/user interactions will be dispatched under lora-short-video-events event name. Example: To see a preview of how it works, you can run the below code in a browser console and open the player separately.

window.addEventListener("lora-short-video-events", (event) => {
    console.log(event.detail.name); // eg: sv-on-load
    console.log(event.detail.data); // example output below
});

Example output : Full sample data of lora-short-video-events payload

{
    name: "sv-on-load", // Event name
    data: { // Data payload
        device: "DESKTOP", // DESKTOP / TABLET / MOBILE
        domain: 'CURRENT_EMBED_DOMAIN',
        is_playlist: true,
        organization_id: "ORGANIZATION_ID",
        playlist: {
            playlist_id: 'AAAAAAA-BBB-CCCCC-DDDDD-EEEEEE',
            playlist_story_type: "GRID", // STORY_BLOCK / CAROUSEL / GRID
        }
        video: {
            thumbnail: 'https://thumbnail.url'
            video_id: 'AAAAAAA-BBB-CCCCC-DDDDD-EEEEEE',
            video_title: 'THE VIDEO TITLE',
            video_url: 'https://video.url',
        }
    }
}

Events​

sv-on-load​

Emitted when the short video is loaded.

{
    name: "sv-on-load",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-view​

Emitted when short video is sending out the tracking view periodically.

{
    name: "sv-view",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        video_current_time: 'VIDEO_CURRENT_TIME',
        video_percent: 'VIDEO_CURRENT_PERCENT',
        video_duration: 'VIDEO_DURATION'
    }
}

sv-share​

Emitted when viewers click share button.

{
    name: "sv-share",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        url: 'SHARE_URL'
    }
}

sv-product-cta-click​

Emitted when cta link is clicked.

{
    name: "sv-product-cta-click",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        product: {...}
    }
}

sv-mute​

Emitted when video has muted.

{
    name: "sv-mute",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-unmute​

Emitted when video has unmuted.

{
    name: "sv-unmute",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-pause​

Emitted when the player has paused.

{
    name: "sv-pause",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-resume​

Emitted when the player has resumed.

{
    name: "sv-resume",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-enter-fullscreen​

Emitted when enter fullscreen.

{
    name: "sv-enter-fullscreen",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-exit-fullscreen​

Emitted when exit fullscreen.

{
    name: "sv-exit-fullscreen",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
    }
}

sv-qa​

Emitted when user submits an answer.

{
    name: "sv-qa",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        answered: "ANSWERED",
        question: "QUESTION",
    }
}

sv-qa-follow-up​

Emitted when user submits an answer.

{
    name: "sv-qa-follow-up",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        answered: "ANSWERED",
        question: "QUESTION",
    }
}

sv-poll-answer​

Emitted when user submits a poll.

{
    name: "sv-poll-answer",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-add-to-cart​

Emitted when user adds any item to cart.

{
    name: "sv-add-to-cart",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-decrease-from-cart​

Emitted when user decrease the quantity of any item from the cart.

{
    name: "sv-decrease-from-cart",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-remove-from-cart​

Emitted when user remove any item from the cart.

{
    name: "sv-remove-from-cart",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-open-cart​

Emitted when user open the cart.

{
    name: "sv-open-cart",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-hide-cart​

Emitted when user hide the cart.

{
    name: "sv-hide-cart",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

sv-checkout​

Emitted when user start to process checkout.

{
    name: "sv-checkout",
    data: {
        domain: 'CURRENT_EMBED_DOMAIN',
        device: 'DEVICE_TYPE',
        is_playlist: true,
        organization_id: 'ORGANIZATION_ID',
        playlist: {...},
        video: {...},
        items: [LIST ITEMS],
        total_price: TOTAL VALUE,
        poll_title: "TITLE",
        answered: "OPTION ID",
    }
}

Properties​

Video​

    video: {
        thumbnail: "THUMBNAIL_URL",
        video_id: "VIDEO_ID",
        video_title: "VIDEO_TITLE",
        video_url: "VIDEO_URL",
    }

Playlist​

Playlist is only available when is_playlist is true.

    playlist: {
        playlist_id: "PLAYLIST_ID",
        playlist_story_type: "GRID", // STORY_BLOCK / CAROUSEL / GRID
    }

Product​

Product is only available when sv-product-cta-click is emitted.

    product: {
        cta_link: "CTA URL",
        image: "IMAGE URL",
        price: 120,
        item_id: "PRODUCT ID",
        item_name: "PRODUCT NAME",
        .. other properties
    }

Items​

Product is only available when ecommerce events: sv-add-to-cart, sv-decrease-from-cart, sv-remove-from-cart, sv-open-cart, sv-hide-cart, sv-checkout is emitted.

    items: [
        // List of products
        {
            cta_link: "CTA URL",
            image: "IMAGE URL",
            price: 120,
            item_id: "PRODUCT ID",
            item_name: "PRODUCT NAME",
            ... other properties
        },
        ...
    ]