Shopee Ads Connector Reference

16 metrics30 dimensions

The Shopee Ads connector exposes 46 fields (16 metrics, 30 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Shopee Ads Fields

Shopee Ads cpc_ads_daily fields

The cpc_ads_daily report of the Shopee Ads connector includes 15 fields.

IDTypeNameDescription
broad_conversionsPERCENTBroad Conversion RateBroad orders divided by clicks.
broad_gmvNUMERICBroad GMVSales from any shop item over the attribution window.
broad_item_soldNUMERICBroad Items SoldAny shop items sold within 7 days of an ad click.
broad_orderNUMERICBroad OrdersOrders of any shop item within 7 days of an ad click.
broad_roasNUMERICBroad ROASBroad GMV divided by expense.
clicksNUMERICClicksThe total number of clicks on the ads.
cost_per_conversionNUMERICCost Per ConversionThe average ad cost per sales conversion.
ctrPERCENTCTRClick-through rate, calculated as clicks divided by impressions.
direct_conversionsPERCENTDirect Conversion RateDirect orders divided by clicks.
direct_gmvNUMERICDirect GMVSales from the advertised item over the attribution window.
direct_item_soldNUMERICDirect Items SoldAdvertised items sold within 7 days of an ad click.
direct_orderNUMERICDirect OrdersOrders of the advertised item within 7 days of an ad click.
direct_roasNUMERICDirect ROASDirect GMV divided by expense.
expenseNUMERICExpenseThe ad expenditure.
impressionsNUMERICImpressionsThe number of times buyers saw the ads.

Shopee Ads product_campaigns fields

The product_campaigns report of the Shopee Ads connector includes 3 fields.

IDTypeNameDescription
campaign_ad_typeTEXTCampaign Ad TypeThe campaign ad type, auto or manual.
campaign_idTEXTCampaign IDThe product campaign ID.
regionREGIONRegionThe two-letter region code of the shop, for example ID.

Shopee Ads other fields

The Shopee Ads connector has 24 fields that do not belong to a named report, or belong to a report with only one or two fields.

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe Shopee shop ID.
account_nameTEXTAccount NameThe Shopee shop name.
balance_timestampTIMESTAMPBalance TimestampThe time of the balance snapshot. ISO 8601 datetime (UTC).total_balance
data_fetched_atTIMESTAMPData fetched atUTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThe date of the record.
day_of_monthTEXTDay of monthDay of the month
hourTEXTHourThe hour of the day (0-23) of the hourly record.cpc_ads_hourly
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
total_balanceNUMERICTotal BalanceThe ads credit balance, including paid and free credits.total_balance
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20