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

    Interface GetAllCpcAdsHourlyPerformanceResponse

    Response for the get all CPC ads hourly performance API

    interface GetAllCpcAdsHourlyPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            broad_conversions: number;
            broad_gmv: number;
            broad_item_sold: number;
            broad_order: number;
            broad_roas: number;
            clicks: number;
            cost_per_conversion: number;
            ctr: number;
            date: string;
            direct_conversions: number;
            direct_gmv: number;
            direct_item_sold: number;
            direct_order: number;
            direct_roas: number;
            expense: number;
            hour: number;
            impression: number;
        }[];
        warning?: string;
    }

    Hierarchy (View Summary)

    Index

    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: {
        broad_conversions: number;
        broad_gmv: number;
        broad_item_sold: number;
        broad_order: number;
        broad_roas: number;
        clicks: number;
        cost_per_conversion: number;
        ctr: number;
        date: string;
        direct_conversions: number;
        direct_gmv: number;
        direct_item_sold: number;
        direct_order: number;
        direct_roas: number;
        expense: number;
        hour: number;
        impression: number;
    }[]

    Type Declaration

    • broad_conversions: number

      Broad conversion rate (Ad orders / total clicks) - any item from the same shop gets purchased

    • broad_gmv: number

      Total broad sales generated from ads over a 7-day window (any item from the same shop)

    • broad_item_sold: number

      Items sold within 7 days after clicking on the ads (any item from the same shop)

    • broad_order: number

      Broad conversions - buyer placed an order within 7 days after clicking on the ads (any item from the same shop)

    • broad_roas: number

      Broad ROAS - Ad GMV/Ad Expenditure (any item from the same shop gets purchased)

    • clicks: number

      Total number of clicks on the Ad

    • cost_per_conversion: number

      Cost per conversion - ad's average cost per sales conversion

    • ctr: number

      Click-through rate (Clicks / Impressions)

    • date: string

      Date the performance record belongs to (DD-MM-YYYY format)

    • direct_conversions: number

      Direct conversion rate (Ad orders / total clicks) - item gets purchased from the clicked ads

    • direct_gmv: number

      Total direct sales generated from ads over a 7-day window (item gets purchased from the clicked ads)

    • direct_item_sold: number

      Items sold within 7 days after clicking on the ads (item gets purchased from the clicked ads)

    • direct_order: number

      Direct conversions - buyer placed an order within 7 days after clicking on the ads (item gets purchased from the clicked ads)

    • direct_roas: number

      Direct ROAS - Ad GMV/Ad Expenditure (item gets purchased from the clicked ads)

    • expense: number

      Ad expenditure

    • hour: number

      Hour the performance record belongs to

    • impression: number

      Number of times buyers see ads

    warning?: string

    Optional warning message if some data cannot be responded normally