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

    Interface GetCampaignKeyMetricsPerformanceResponse

    Response for get_campaign_key_metrics_performance API

    interface GetCampaignKeyMetricsPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            clicks?: number;
            est_commission?: string;
            orders?: number;
            roi?: string;
            sales?: string;
        };
        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: {
        clicks?: number;
        est_commission?: string;
        orders?: number;
        roi?: string;
        sales?: string;
    }

    Type Declaration

    • Optionalclicks?: number

      Total clicks

    • Optionalest_commission?: string

      Total estimated commission

    • Optionalorders?: number

      Total orders

    • Optionalroi?: string

      ROI

    • Optionalsales?: string

      Total sales

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties