v2.ads.get_product_campaign_hourly_performance

GET /api/v2/ads/get_product_campaign_hourly_performance

Use this API to get Product level ads single-day hourly performance.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ads/get_product_campaign_hourly_performance

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
performance_date	string	True	17-07-2024	This is the parameter to indicate the start date of the time length of performance.
campaign_id_list	string	True	11111,22222	The campaign ids (comma separated) you want to fetch the performance. (max 100)

Response Parameters

Name	Type	Sample	Description
error	string		Error code, empty when no error returned
message	string		error description
warning	string		If some data cannot respond normally, set the warning
request_id	string	6f235f4a343e4feb8a9ed74c439f6663	request id is unique for each request
response	object[]		response body
shop_id	int64	123	Shopee's unique identifier for a shop
region	string	SG	The region where this Shop is under
campaign_list	object[]		the list of campaign
campaign_id	int64	12121	The unique identifier for a campaign
ad_type	string	auto	auto, manual
campaign_placement	string	search	search, discovery, all
ad_name	string	name	the name of each campaign
metrics_list	object[]		performance metric list
hour	int32	14	This is the parameter to indicate each hour the performance record belongs to.
date	string	12-12-2023	This is the parameter of the single date on which requestor wants to check the hourly performance
impression	int64	111	The number of times shoppers see your ad.
clicks	int64	222	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.)
ctr	float	12.23	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 × 100%.
expense	float	11.22	The amount spent on your ad.
broad_gmv	float	1.2	The amount of sales revenue generated from shoppers purchasing products within 7 days of them clicking on your ad.
broad_order	int64	100	The number of times shoppers purchased any product from your shop within 7 days of them clicking on your ad.
broad_order_amount	int64	200	The total quantity of products purchased by shoppers within 7 days of them clicking on your ad.
broad_roi	float	2.3	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.)
broad_cir	float	3.4	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%.
cr	float	4.5	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 × 100%.
cpc	float	5.6	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.
direct_order	int64	999	The number of times shoppers purchased the advertised product within 7 days of them clicking on the ad.
direct_order_amount	int64	1111	The total quantity of the advertised product purchased by shoppers within 7 days of them clicking on the ad.
direct_gmv	float	12.23	The amount of sales revenue generated from shoppers purchasing the advertised product within 7 days of them clicking on the ad.
direct_roi	float	23.34	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.
direct_cir	float	34.45	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%.
direct_cr	float	45.56	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 × 100%.
cpdc	float	56.67	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.