v2.ads.get_all_cpc_ads_hourly_performance

GET /api/v2/ads/get_all_cpc_ads_hourly_performance

Use this API to get Shop level CPC ads single-date hourly performance.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ads/get_all_cpc_ads_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-03-2021	This is the parameter of the single date on which requester wants to check the hourly performance. Date in DD-MM-YYYY format.

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
hour	int32	13	This is the parameter to indicate each hour the performance record belongs to.
date	string	17-03-2021	This is the parameter to indicate which date the performance record belongs to.
impression	int32	123456	Number of times buyers see ads
clicks	int32	123456	Total number of clicks on the Ad
ctr	float	1.23	Ctr, click-through rate measures how often shoppers who see an ad end up clicking it. CTR = Clicks / Impressions
direct_order	int32	123456	Buyer place an order within 7 days after clicking on the ads (item gets purchased from the clicked ads). Please kindly note that the direct_order in the API reflected to Seller Center Shopee Ads Module FE is Direct Conversions.
broad_order	int32	123456	Buyer place an order within 7 days after clicking on the ads; (the item gets purchased as long as there are other items from the same shops got click.) Please kindly note that the broad_order in the APIreflected to Seller Center Shopee Ads Module FE is Conversions.
direct_conversions	float	1.23	Ad orders / total number of clicks on the Ad. (item gets purchased from the clicked ads.) Please kindly note that the direct_conversions in the API reflected to Seller Center Shopee Ads Module FE is the Direct Conversion Rate
broad_conversions	float	1.23	Ad orders / total number of clicks on the Ad. (the item gets purchased as long as there are other items from the same shops got click.) Please kindly note that the broad conversions in the API reflected to Seller Center Shopee Ads Module FE is Conversion Rate
direct_item_sold	int32	123	item sold within 7 days after clicking on the ads. (item gets purchased from the clicked ads.)
broad_item_sold	int32	123	item sold within 7 days after clicking on the ads.(the item gets purchased as long as there are other items from the same shops got click.)
direct_gmv	float	1.23	Total sales generated from Ad over a certain time frame Typically 7 days. (item gets purchased from the clicked ads.)
broad_gmv	float	1.23	Total sales generated from Ad over a certain time frame (the item gets purchased as long as there are other items from the same shops got click.)
expense	float	1.23	Ad Expenditure
cost_per_conversion	float	1.23	(Cost Per Conversion) Ad's average cost per sales conversion
direct_roas	float	1.23	Ad GMV/Ad Expenditure. (item gets purchased from the clicked ads.)
broad_roas	float	1.23	Ad GMV/Ad Expenditure. (the item gets purchased as long as there are other items from the same shops got click.)