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

    Interface GetCampaignKeyMetricsPerformanceRequest

    Request parameters for get_campaign_key_metrics_performance

    Retrieve key metrics for Open and Targeted campaigns

    interface GetCampaignKeyMetricsPerformanceRequest {
        end_date: string;
        period_type: string;
        start_date: string;
    }
    Index

    Properties

    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.

    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.