Shopee Ads fields

Early Access20 metrics38 dimensions

Search fields

ad_name

Field label	Ad name
Description	The name of each ad
Field type	dimension
Data type	string.text.value

ad_status

Field label	Ad status
Description	The status of the ad (e.g., active, paused, etc.)
Field type	dimension
Data type	string.text.value

ad_type

Field label	Ad type
Description	The type of ad (e.g., auto, manual)
Field type	dimension
Data type	string.text.value

placement

Field label	Placement
Description	The placement of the campaign (e.g., search, discovery, all)
Field type	dimension
Data type	string.text.value

budget

Field label	Budget
Description	The budget per campaign. Please kindly note that if the campaign budget = 0, it means the budget set for this campaign is unlimited
Field type	dimension
Data type	string.text.value

product_id

Field label	Product ID
Description	Unique identifier for the product
Field type	dimension
Data type	string.text.value

keyword

Field label	Keyword
Description	Bid keywords for each campaign with search placement
Field type	dimension
Data type	string.text.value

location

Field label	Location
Description	Bid keywords for each campaign with search placement
Field type	dimension
Data type	string.text.value

match_type

Field label	Match type
Description	The keyword match type
Field type	dimension
Data type	string.text.value

bidding_method

Field label	Bidding method
Description	The bidding method used for the ad (auto, manual)
Field type	dimension
Data type	string.text.value

DATASOURCE

dataSourceName

Field label	Data source
Description	The name of the source for this data, as listed on supermetrics.com/docs
Field type	dimension
Data type	string.text.value
Destinations	API, Data warehouse

system_metadata.data_source_logins

Field label	Data source logins
Description	The data source login accounts that were used to authenticate against the data source
Field type	dimension
Data type	string.text.json

system_metadata.data_source_login_owners

Field label	Data source login owners
Description	The Supermetrics users that created the data source login connections
Field type	dimension
Data type	string.text.json

DIRECT REVENUE

direct_conversions

Field label	Direct conversions
Description	The number of times shoppers purchased the advertised product within 7 days of them clicking on the ad
Field type	metric
Data type	float.number.ratio

direct_conversion_rate

Field label	Direct conversion rate
Description	The direct conversion rate measures how often shoppers end up purchasing the advertised product after clicking on the ad. Direct conversion rate is the number of direct conversions divided by the number of clicks (Direct conversion rate = direct conversions ÷ clicks)
Field type	metric
Data type	float.number.ratio

cost_per_direct_conversions

Field label	Cost per direct conversion
Description	The cost per direct conversion is how much each direct conversion costs, on average. It is the amount spent on your ad divided by the number of direct conversions attributed to the ad (Cost per direct conversion = expense ÷ direct conversions)
Field type	metric
Data type	float.number.value

direct_items_sold

Field label	Direct items sold
Description	The total quantity of the advertised product purchased by shoppers within 7 days of them clicking on the ad
Field type	metric
Data type	int.number.value

direct_gmv

Field label	Direct GMV
Description	The amount of sales revenue generated from shoppers purchasing the advertised product within 7 days of them clicking on the ad
Field type	metric
Data type	float.currency.value

direct_roas

Field label	Direct ROAS
Description	The direct return on ad spend, or direct ROAS, measures how much revenue is generated from sales of the advertised product, relative to the cost of the ad. It is the amount of sales revenue for the advertised product attributed to the ad, divided by the amount spent on the ad (Direct ROAS = direct GMV ÷ expense)
Field type	metric
Data type	float.number.ratio

direct_acos

Field label	Direct ACOS
Description	The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad (Direct ACOS = expense ÷ direct GMV × 100)
Field type	metric
Data type	float.number.value

PERFORMANCE

impressions

Field label	Impressions
Description	The number of times shoppers see your ad
Field type	metric
Data type	int.number.value

clicks

Field label	Clicks
Description	The number of times shoppers click on your ad. (Note: Shopee filters out repeated clicks from the same shopper that occur within a short time frame.)
Field type	metric
Data type	int.number.value

ctr

Field label	CTR
Description	The click-through rate (CTR) measures how often shoppers end up clicking on your ad after seeing it. It is the number of clicks on your ad divided by the number of times your ad is seen (CTR = clicks ÷ impressions)
Field type	metric
Data type	float.number.ratio

expense

Field label	Expense
Description	The amount spent on your ad
Field type	metric
Data type	float.currency.value

cpm

Field label	CPM
Description	Cost per mille (CPM), also called cost per thousand, represents how much you pay for 1,000 ad impressions (CPM = expense ÷ impressions × 1000)
Field type	metric
Data type	float.currency.value

cpc

Field label	CPC
Description	The cost per click (CPC) is the amount you pay for each click on your ad (CPC = expense ÷ clicks)
Field type	metric
Data type	float.currency.value

QUERY

system_metadata.query_date_range_start

Field label	Start date
Description	The start date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_date_range_end

Field label	End date
Description	The end date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_timezone

Field label	Timezone
Description	The timezone that is supplied to the query
Field type	dimension
Data type	string.time.timezone

system_metadata.query_filters

Field label	Filters
Description	All filters used in the query
Field type	dimension
Data type	string.text.json

system_metadata.query_date_start

Field label	Start
Description	When the query was started
Field type	dimension
Data type	string.time.datetime

system_metadata.query_date_end

Field label	End
Description	When the query completed
Field type	dimension
Data type	string.time.datetime

system_metadata.query_duration

Field label	Duration
Description	The duration in seconds of the query
Field type	dimension
Data type	int.duration.seconds

system_metadata.query_accounts

Field label	Accounts
Description	A list of accounts of which the data was pulled from
Field type	dimension
Data type	string.text.json

REVENUE

conversions

Field label	Conversions
Description	The number of times shoppers purchased any product from your shop within 7 days of them clicking on your ad
Field type	metric
Data type	int.number.value

conversion_rate

Field label	Conversion rate
Description	The conversion rate measures how often shoppers end up purchasing something from your shop after clicking on your ad. It is the number of conversions attributed to your ad divided by the number of clicks on the ad (Conversion rate = conversions ÷ clicks)
Field type	metric
Data type	float.number.ratio

cost_per_conversion

Field label	Cost per conversion
Description	The cost per conversion is how much each conversion costs, on average. It is the amount spent on your ad divided by the number of conversions attributed to the ad (Cost per conversion = expense ÷ conversions)
Field type	metric
Data type	int.number.value

items_sold

Field label	Items sold
Description	The total quantity of products purchased by shoppers within 7 days of them clicking on your ad
Field type	metric
Data type	float.number.value

gmv

Field label	GMV
Description	The amount of sales revenue generated from shoppers purchasing products within 7 days of them clicking on your ad
Field type	metric
Data type	float.currency.value

roas

Field label	ROAS
Description	Return on ad spend (ROAS) measures how much revenue is generated by your ad relative to the cost of the ad. It is the amount of sales revenue attributed to your ad divided by the amount spent on the ad (ROAS = GMV ÷ expense). (Note: We recommend monitoring ROAS trends on a weekly basis.)
Field type	metric
Data type	float.number.ratio

acos

Field label	ACOS
Description	The advertising cost of sales (ACOS) measures how much your ad costs relative to the revenue the ad generates. It is the amount spent on your ad divided by the amount of sales revenue attributed to the ad (ACOS = expense ÷ GMV × 100)
Field type	metric
Data type	float.number.ratio

STORE

store_name

Field label	Store name
Field type	dimension
Data type	string.text.value

store_id

Field label	Store ID
Field type	dimension
Data type	string.text.value

TIME

today

Field label	Today
Description	Today's date, e.g. 2017-01-31
Field type	dimension
Data type	string.time.date
Destinations	API, Data warehouse

year

Field label	Year
Field type	dimension
Data type	string.time.year

year_of_week

Field label	Year of week (Sun-Sat)
Field type	dimension
Data type	string.time.year

year_of_week_iso

Field label	Year of week (Mon-Sun)
Field type	dimension
Data type	string.time.year

year_month

Field label	Year & month
Field type	dimension
Data type	string.time.yearmonth

month

Field label	Month
Field type	dimension
Data type	string.time.month

year_week

Field label	Year & week (Sun-Sat)
Field type	dimension
Data type	string.time.yearweek

year_week_iso

Field label	Year & week (Mon-Sun)
Field type	dimension
Data type	string.time.yearweekiso

week

Field label	Week (Sun-Sat)
Field type	dimension
Data type	string.time.week

week_iso

Field label	Week (Mon-Sun)
Field type	dimension
Data type	string.time.weekiso

day_of_month

Field label	Day of month
Field type	dimension
Data type	string.time.dayofmonth

day_of_week_name

Field label	Day of week (Sun-Sat)
Field type	dimension
Data type	string.time.dayofweek

day_of_week_name_iso

Field label	Day of week (Mon-Sun)
Field type	dimension
Data type	string.time.dayofweekiso

date

Field label	Date
Field type	dimension
Data type	string.time.date

atom

Field label	Datetime
Field type	dimension
Data type	string.time.datetime