Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Interface GetSessionMetricResponse

    Response for getting session metrics

    interface GetSessionMetricResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            atc: number;
            avg_viewing_duration: number;
            ccu: number;
            co: number;
            comments: number;
            ctr: number;
            engage_ccu_1m: number;
            gmv: number;
            likes: number;
            orders: number;
            peak_ccu: number;
            shares: number;
            views: number;
        };
        warning?: string
        | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    error message request_id response warning?

    Properties

    error: string

    Error code if any error occurred

    message: string

    Error message if any error occurred

    request_id: string

    The identifier for an API request for error tracking

    response: {
        atc: number;
        avg_viewing_duration: number;
        ccu: number;
        co: number;
        comments: number;
        ctr: number;
        engage_ccu_1m: number;
        gmv: number;
        likes: number;
        orders: number;
        peak_ccu: number;
        shares: number;
        views: number;
    }

    Type Declaration

    • atc: number

      Number of "Add To Cart" clicks

    • avg_viewing_duration: number

      Average viewing duration

    • ccu: number

      Number of concurrent viewers

    • co: number

      Conversion rate

    • comments: number

      Number of comments

    • ctr: number

      Click-through rate

    • engage_ccu_1m: number

      Number of engaged concurrent viewers (>1 min)

    • gmv: number

      Value of placed orders during livestream

    • likes: number

      Number of likes

    • orders: number

      Number of placed orders

    • peak_ccu: number

      Peak concurrent viewers

    • shares: number

      Number of shares

    • views: number

      Number of views

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties