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

    Interface GetMarketingHotListingResponseData

    Response data payload for get_marketing_hot_listing

    interface GetMarketingHotListingResponseData {
        code?: number;
        msg?: string;
        result?: any[];
        result_key_metrics?: any;
        result_key_metrics_key_metrics?: any;
        result_key_metrics_key_metrics_buyers?: number;
        result_key_metrics_key_metrics_buyers_pct_diff?: number;
        result_key_metrics_key_metrics_click_through_rate?: number;
        result_key_metrics_key_metrics_click_through_rate_pct_diff?: number;
        result_key_metrics_key_metrics_conversion_rate?: number;
        result_key_metrics_key_metrics_conversion_rate_pct_diff?: number;
        result_key_metrics_key_metrics_orders?: number;
        result_key_metrics_key_metrics_orders_pct_diff?: number;
        result_key_metrics_key_metrics_product_clicks?: number;
        result_key_metrics_key_metrics_product_clicks_pct_diff?: number;
        result_key_metrics_key_metrics_product_impression?: number;
        result_key_metrics_key_metrics_product_impression_pct_diff?: number;
        result_key_metrics_key_metrics_sales?: number;
        result_key_metrics_key_metrics_sales_pct_diff?: number;
        result_key_metrics_key_metrics_units?: number;
        result_key_metrics_key_metrics_units_pct_diff?: number;
        result_key_metrics_time_series?: any[];
        result_key_metrics_time_series_buyers?: number;
        result_key_metrics_time_series_click_through_rate?: number;
        result_key_metrics_time_series_conversion_rate?: number;
        result_key_metrics_time_series_orders?: number;
        result_key_metrics_time_series_product_clicks?: number;
        result_key_metrics_time_series_product_impression?: number;
        result_key_metrics_time_series_sales?: number;
        result_key_metrics_time_series_t?: number;
        result_key_metrics_time_series_units?: number;
        result_order_type?: string;
        result_performance?: any[];
        result_performance_buyers?: number;
        result_performance_click_through_rate?: number;
        result_performance_conversion_rate?: number;
        result_performance_image?: string;
        result_performance_item_id?: number;
        result_performance_item_name?: string;
        result_performance_orders?: number;
        result_performance_product_clicks?: number;
        result_performance_product_impression?: number;
        result_performance_sales?: number;
        result_performance_status?: number;
        result_performance_units?: number;
        result_performance_variation_name?: string;
    }
    Index

    Properties

    code? msg? result? result_key_metrics? result_key_metrics_key_metrics? result_key_metrics_key_metrics_buyers? result_key_metrics_key_metrics_buyers_pct_diff? result_key_metrics_key_metrics_click_through_rate? result_key_metrics_key_metrics_click_through_rate_pct_diff? result_key_metrics_key_metrics_conversion_rate? result_key_metrics_key_metrics_conversion_rate_pct_diff? result_key_metrics_key_metrics_orders? result_key_metrics_key_metrics_orders_pct_diff? result_key_metrics_key_metrics_product_clicks? result_key_metrics_key_metrics_product_clicks_pct_diff? result_key_metrics_key_metrics_product_impression? result_key_metrics_key_metrics_product_impression_pct_diff? result_key_metrics_key_metrics_sales? result_key_metrics_key_metrics_sales_pct_diff? result_key_metrics_key_metrics_units? result_key_metrics_key_metrics_units_pct_diff? result_key_metrics_time_series? result_key_metrics_time_series_buyers? result_key_metrics_time_series_click_through_rate? result_key_metrics_time_series_conversion_rate? result_key_metrics_time_series_orders? result_key_metrics_time_series_product_clicks? result_key_metrics_time_series_product_impression? result_key_metrics_time_series_sales? result_key_metrics_time_series_t? result_key_metrics_time_series_units? result_order_type? result_performance? result_performance_buyers? result_performance_click_through_rate? result_performance_conversion_rate? result_performance_image? result_performance_item_id? result_performance_item_name? result_performance_orders? result_performance_product_clicks? result_performance_product_impression? result_performance_sales? result_performance_status? result_performance_units? result_performance_variation_name?

    Properties

    code?: number

    Business status code. 0 indicates success.

    msg?: string

    Business status message. The value is ok on success.

    result?: any[]

    Metrics for every order type supported by the shop country. Non-COD shops return placed and paid; COD shops additionally return confirmed.

    result_key_metrics?: any

    Shop-level summary metrics and time-series data for the order type.

    result_key_metrics_key_metrics?: any

    Shop-level summary metrics for the requested period.

    result_key_metrics_key_metrics_buyers?: number

    Number of buyers.

    result_key_metrics_key_metrics_buyers_pct_diff?: number

    Buyer-count change compared with the previous period.

    result_key_metrics_key_metrics_click_through_rate?: number

    Product click-through rate.

    result_key_metrics_key_metrics_click_through_rate_pct_diff?: number

    Click-through-rate change compared with the previous period.

    result_key_metrics_key_metrics_conversion_rate?: number

    Conversion rate.

    result_key_metrics_key_metrics_conversion_rate_pct_diff?: number

    Conversion-rate change compared with the previous period.

    result_key_metrics_key_metrics_orders?: number

    Number of orders.

    result_key_metrics_key_metrics_orders_pct_diff?: number

    Order-count change compared with the previous period.

    result_key_metrics_key_metrics_product_clicks?: number

    Number of product clicks.

    result_key_metrics_key_metrics_product_clicks_pct_diff?: number

    Product-click change compared with the previous period.

    result_key_metrics_key_metrics_product_impression?: number

    Number of product impressions.

    result_key_metrics_key_metrics_product_impression_pct_diff?: number

    Product-impression change compared with the previous period.

    result_key_metrics_key_metrics_sales?: number

    Sales amount for the order type.

    result_key_metrics_key_metrics_sales_pct_diff?: number

    Sales change compared with the previous period.

    result_key_metrics_key_metrics_units?: number

    Number of units sold.

    result_key_metrics_key_metrics_units_pct_diff?: number

    Units-sold change compared with the previous period.

    result_key_metrics_time_series?: any[]

    Shop-level metrics grouped by time bucket.

    result_key_metrics_time_series_buyers?: number

    Number of buyers in the time bucket.

    result_key_metrics_time_series_click_through_rate?: number

    Product click-through rate in the time bucket.

    result_key_metrics_time_series_conversion_rate?: number

    Conversion rate in the time bucket.

    result_key_metrics_time_series_orders?: number

    Number of orders in the time bucket.

    result_key_metrics_time_series_product_clicks?: number

    Number of product clicks in the time bucket.

    result_key_metrics_time_series_product_impression?: number

    Number of product impressions in the time bucket.

    result_key_metrics_time_series_sales?: number

    Sales amount in the time bucket.

    result_key_metrics_time_series_t?: number

    Unix timestamp in seconds representing the time bucket.

    result_key_metrics_time_series_units?: number

    Number of units sold in the time bucket.

    result_order_type?: string

    Order type represented by this entry. Possible values are placed, confirmed, and paid.

    result_performance?: any[]

    Product-level performance sorted by sales in descending order.

    result_performance_buyers?: number

    Number of buyers.

    result_performance_click_through_rate?: number

    Product click-through rate.

    result_performance_conversion_rate?: number

    Conversion rate.

    result_performance_image?: string

    Product image identifier or URL.

    result_performance_item_id?: number

    Product ID.

    result_performance_item_name?: string

    Product name.

    result_performance_orders?: number

    Number of orders.

    result_performance_product_clicks?: number

    Number of product clicks.

    result_performance_product_impression?: number

    Number of product impressions.

    result_performance_sales?: number

    Sales amount for the order type.

    result_performance_status?: number

    Product status code.

    result_performance_units?: number

    Number of units sold.

    result_performance_variation_name?: string

    Product variation or model name.

    Settings

    Member Visibility

    On This Page

    Properties
    codemsgresultresult_key_metricsresult_key_metrics_key_metricsresult_key_metrics_key_metrics_buyersresult_key_metrics_key_metrics_buyers_pct_diffresult_key_metrics_key_metrics_click_through_rateresult_key_metrics_key_metrics_click_through_rate_pct_diffresult_key_metrics_key_metrics_conversion_rateresult_key_metrics_key_metrics_conversion_rate_pct_diffresult_key_metrics_key_metrics_ordersresult_key_metrics_key_metrics_orders_pct_diffresult_key_metrics_key_metrics_product_clicksresult_key_metrics_key_metrics_product_clicks_pct_diffresult_key_metrics_key_metrics_product_impressionresult_key_metrics_key_metrics_product_impression_pct_diffresult_key_metrics_key_metrics_salesresult_key_metrics_key_metrics_sales_pct_diffresult_key_metrics_key_metrics_unitsresult_key_metrics_key_metrics_units_pct_diffresult_key_metrics_time_seriesresult_key_metrics_time_series_buyersresult_key_metrics_time_series_click_through_rateresult_key_metrics_time_series_conversion_rateresult_key_metrics_time_series_ordersresult_key_metrics_time_series_product_clicksresult_key_metrics_time_series_product_impressionresult_key_metrics_time_series_salesresult_key_metrics_time_series_tresult_key_metrics_time_series_unitsresult_order_typeresult_performanceresult_performance_buyersresult_performance_click_through_rateresult_performance_conversion_rateresult_performance_imageresult_performance_item_idresult_performance_item_nameresult_performance_ordersresult_performance_product_clicksresult_performance_product_impressionresult_performance_salesresult_performance_statusresult_performance_unitsresult_performance_variation_name