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

    Interface GetVideoPerformanceListRequest

    Request parameters for get_video_performance_list

    Get specific performance data for individual post Shopee Video. There is at least a one-day delay.

    interface GetVideoPerformanceListRequest {
        caption?: string;
        end_date: string;
        order_by: string;
        page_no: number;
        page_size: number;
        period_type: string;
        sort: string;
    }
    Index

    Properties

    caption?: string

    Description of the Shopee Video.

    end_date: string

    The end_date format should be "YYYY-MM-DD".- For Day, Last7d, Last15d, and Last30d, the end_date must before current day.- For Week, the end_date must be Sunday and must be less than or equal to the current week.- For Month, the end_date must be the end of the month and must be less than or equal to the current month.

    order_by: string

    Use this field to specify which field to use to sort the returned list. Available values:ViewsLikesCommentsAvgViewsDuration

    page_no: number

    The start index of request. Starting from 1.

    page_size: number

    The number of video returned by this request. Max is 20.

    period_type: string

    Period Type. Applicable values:DayWeekMonthLast7dLast15dLast30dNote: The end date must align with the Period Type.

    sort: string

    Use this field to specify whether the returned list is sorted in ascending or descending order_by. Available values:ascdesc