Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface GetSessionItemMetricRequest

    Request parameters for get_session_item_metric

    Get real-time indicator data of live stream products, including product clicks, add-to-cart, etc. (For TW, ID, TH, PH, MY, SG, VN)

    interface GetSessionItemMetricRequest {
        offset: number;
        page_size: number;
        session_id: number;
    }
    Index

    Properties

    offset: number

    Specifies the starting entry of data to return in the current call. Default is 0, if data is more than one page, the offset can be some entry to start next call.

    page_size: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.

    session_id: number

    The identifier of livestream session.