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

    Interface GetContentPerformanceRequest

    Request parameters for get_content_performance

    Retrieve content performance of the shop

    interface GetContentPerformanceRequest {
        affiliate_id?: number;
        channel: string;
        end_date: string;
        item_id?: number;
        order_type: string;
        page_no: number;
        page_size: number;
        period_type: string;
        start_date: string;
    }
    Index

    Properties

    affiliate_id?: number

    Search for the contents published by affiliates with the affiliate id entered.

    channel: string

    Channel. Applicable values: - ShopeeVideo- LiveStreaming

    end_date: string

    The end_date must be: - Equal to start_date for "Day" period type- Saturday for "Week" period type- The last day of a Month for "Month" period type. If the selected month is the current month, the end_date should be the latest data date- The latest data date for "Last7d" period type- The latest data date for "Last30d" period typeNote: - The end_date must be later than the start_date and earlier than the latest data date- The latest data date can be obtained by using "AmsMarker" in the v2.ams.get_performance_data_update_time API.

    item_id?: number

    Search for the contents with the searched product included (precise search).

    order_type: string

    Order Type. Applicable values: PlacedOrderConfirmedOrder: Note: - Placed orders are orders (COD and non-COD) that buyers have successfully placed, including paid and unpaid orders.- Confirmed orders are either non-COD orders that have been paid for or COD orders that have been confirmed for shipping (usually 30 mins after placing the order).

    page_no: number

    Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.

    page_size: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 20.

    period_type: string

    Period Type. Applicable values:DayWeekMonthLast7dLast30dNote: The start date and end date must align with the Period Type.

    start_date: string

    The start_date must be:- Any day in the past three calendar months for "Day" period type- Sunday for "Week" period type- The 1st day of a Month for "Month" period type- The date that is 6 days prior to the latest data date for "Last7d" period type- The date that is 29 days prior to the latest data date for "Last30d" period typeNote: The latest data date can be obtained by using "AmsMarker" in the v2.ams.get_performance_data_update_time API.