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

    Interface GetClipVideoPerformanceResponseData

    GetClipVideoPerformanceResponseData sub-interface for GetClipVideoPerformanceResponse

    interface GetClipVideoPerformanceResponseData {
        details?: GetClipVideoPerformanceDetail[];
        next_cursor?: number;
        summary?: GetClipVideoPerformanceSummary[];
    }
    Index

    Properties

    List of video-level detail records that returns performance metrics for each selected video within the requested date range.Details are sorted by shop_id and then video_id in ascending order.- unique_viewers and total_unique_buyers are unavailable for customize, month, quarter, year, and non-full-week weekly ranges.

    next_cursor?: number

    Offset to be used in the next request for fetching the next page of detail records.Notes:- Returned only when video_list is omitted or an empty array.- Calculated as cursor + returned_detail_count.- If returned_detail_count is less than page_size, it indicates there may be no more records.- If the request is already beyond the end of the result set, the API returns 0 detail records and next_cursor remains equal to the input cursor.

    Aggregated summary metrics for the requested date range, representing the overall performance of the selected videos.Note:- unique_viewers and total_unique_buyers are unavailable for customize, month, quarter, year, and non-full-week weekly ranges.