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

    Interface GetClipVideoPerformanceResponse

    Response for get_clip_video_performance

    interface GetClipVideoPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            details?: GetClipVideoPerformanceDetail[];
            next_cursor?: number;
            summary?: GetClipVideoPerformanceSummary[];
        };
        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: {
        details?: GetClipVideoPerformanceDetail[];
        next_cursor?: number;
        summary?: GetClipVideoPerformanceSummary[];
    }

    Type Declaration

    • Optionaldetails?: GetClipVideoPerformanceDetail[]
    • Optionalnext_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.

    • Optionalsummary?: GetClipVideoPerformanceSummary[]
    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties