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.
| ID | Type | Name | Description |
|---|---|---|---|
| broad_conversions | PERCENT | Broad Conversion Rate | Broad orders divided by clicks. |
| broad_gmv | NUMERIC | Broad GMV | Sales from any shop item over the attribution window. |
| broad_item_sold | NUMERIC | Broad Items Sold | Any shop items sold within 7 days of an ad click. |
| broad_order | NUMERIC | Broad Orders | Orders of any shop item within 7 days of an ad click. |
| broad_roas | NUMERIC | Broad ROAS | Broad GMV divided by expense. |
| clicks | NUMERIC | Clicks | The total number of clicks on the ads. |
| cost_per_conversion | NUMERIC | Cost Per Conversion | The average ad cost per sales conversion. |
| ctr | PERCENT | CTR | Click-through rate, calculated as clicks divided by impressions. |
| direct_conversions | PERCENT | Direct Conversion Rate | Direct orders divided by clicks. |
| direct_gmv | NUMERIC | Direct GMV | Sales from the advertised item over the attribution window. |
| direct_item_sold | NUMERIC | Direct Items Sold | Advertised items sold within 7 days of an ad click. |
| direct_order | NUMERIC | Direct Orders | Orders of the advertised item within 7 days of an ad click. |
| direct_roas | NUMERIC | Direct ROAS | Direct GMV divided by expense. |
| expense | NUMERIC | Expense | The ad expenditure. |
| impressions | NUMERIC | Impressions | The number of times buyers saw the ads. |
Shopee Ads product_campaigns fields
The product_campaigns report of the Shopee Ads connector includes 3 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| campaign_ad_type | TEXT | Campaign Ad Type | The campaign ad type, auto or manual. |
| campaign_id | TEXT | Campaign ID | The product campaign ID. |
| region | REGION | Region | The two-letter region code of the shop, for example ID. |
Shopee Ads recommended_items fields
The recommended_items report of the Shopee Ads connector includes 4 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| item_id | TEXT | Item ID | The recommended SKU item ID. |
| item_status_list | TEXT | Item Status List | The item ads-eligibility statuses, comma-separated. |
| ongoing_ad_type_list | TEXT | Ongoing Ad Type List | The ongoing ad types on the item, comma-separated. |
| sku_tag_list | TEXT | SKU Tag List | The item tags such as best selling or best ROI, comma-separated. |
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.
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| account_id | TEXT | Account ID | The Shopee shop ID. | |
| account_name | TEXT | Account Name | The Shopee shop name. | |
| balance_timestamp | Balance Timestamp | The time of the balance snapshot. ISO 8601 datetime (UTC). | total_balance | |
| data_fetched_at | Data fetched at | UTC 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. | ||
| datasource | TEXT | Data Source | The name of the Windsor connector returning the row | |
| date | DATE | Date | The date of the record. | |
| day_of_month | TEXT | Day of month | Day of the month | |
| hour | TEXT | Hour | The hour of the day (0-23) of the hourly record. | cpc_ads_hourly |
| month | TEXT | Month | Number of the month | |
| now | Now | Current timestamp | ||
| source | TEXT | Source | The name of the Windsor connector returning the row | |
| today | DATE | Today | Today's date | |
| total_balance | NUMERIC | Total Balance | The ads credit balance, including paid and free credits. | total_balance |
| week | TEXT | Week | Week (Sun-Sat). | |
| week_day | TEXT | Day of week and day number | Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday. | |
| week_day_iso | TEXT | Day of week and day number, ISO | Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7 | |
| week_iso | TEXT | Week ISO | Week, ISO format (Mon-Sun). | |
| year | TEXT | Year | Year | |
| year_month | TEXT | Yearmonth | Year and month, e.g. 2024|3 | |
| year_month_name | TEXT | Year month name | Year and month with the month name written out, e.g. "Jan 2025". | |
| year_of_week | TEXT | Year of week | The year that contains first day of the week (Sun-Sat). | |
| year_of_week_iso | TEXT | Year of week, ISO | The year that contains first day of the ISO week (Mon-Sun). | |
| year_week | TEXT | Year week | Year and week for US weeks (Sun-Sat), e.g. 2024|15 | |
| year_week_iso | TEXT | Year week ISO | Year and week for ISO weeks (Mon-Sun), e.g. 2024|20 |
