Xiaohongshu Marketing: Most-used fields

The table below gives information about most-used fields that you can import from Xiaohongshu Marketing. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name	Description	Use in Adverity
action_button_click	The number of times an action button within the creative was clicked.	metric
action_button_ctr	The click-through rate for the action button, calculated as action button clicks divided by impressions.	metric
advertiser_id	Unique identifier for the advertiser.	dimension
advertiser_name	Name of the advertiser.	dimension
app_activate_cnt	The number of app activations attributed to the creative.	metric
app_activate_cost	The cost incurred per app activation.	metric
app_activate_ctr	The click-through rate leading to app activations.	metric
app_download_button_click_cnt	The number of clicks on the app download button.	metric
app_download_button_click_cost	The cost incurred per click on the app download button.	metric
app_download_button_click_ctr	The click-through rate for the app download button.	metric
app_pay_amount	The total payment amount generated from in-app purchases attributed to the creative.	metric
app_pay_roi	The Return on Investment (ROI) from in-app payments.	metric
app_register_cnt	The number of new user registrations within the app attributed to the creative.	metric
app_register_cost	The cost incurred per app registration.	metric
app_register_ctr	The click-through rate leading to app registrations.	metric
bidding_strategy	The bidding strategy used for the campaign associated with the creative.	dimension
campaign_id	Unique identifier for the marketing campaign.	dimension
campaign_name	Name of the marketing campaign.	dimension
city	The city where the ad impression or interaction occurred.	dimension
click	The total number of clicks on the creative.	metric
collect	The number of times the creative or associated content was collected/saved by users.	metric
comment	The number of comments received on the creative or associated content.	metric
country_name	The country where the ad impression or interaction occurred.	dimension
cpi	Cost Per Install, the cost incurred for each app installation.	metric
cpm	Cost Per Mille (Cost Per Thousand Impressions), the cost incurred for one thousand ad impressions.	metric
creativity_id	Unique identifier for the creative asset.	dimension
creativity_image	The image used in the creative.	dimension
creativity_name	Name or title of the creative asset.	dimension
ctr	Click-Through Rate, calculated as clicks divided by impressions.	metric
fee	The total advertising cost or fee incurred for the creative.	metric
follow	The number of new followers gained due to the creative.	metric
goods_order	The number of orders placed for goods after interacting with the creative.	metric
goods_order_price	The total price of goods ordered after interacting with the creative.	metric
goods_visit	The number of visits to goods’ pages after interacting with the creative.	metric
goods_visit_price	The total price of goods whose pages were visited after interacting with the creative.	metric
impression	The total number of times the creative was displayed.	metric
initiative_message	The number of initiative messages sent by users after interacting with the creative.	metric
initiative_message_cpl	Cost Per Lead for initiative messages, calculated as cost divided by the number of initiative messages.	metric
interaction	The total number of interactions (e.g., likes, comments, shares) with the creative.	metric
item_id	Unique identifier for the item promoted in the creative.	dimension
landing_page_visit	The number of visits to the landing page associated with the creative.	metric
leads	The total number of leads generated by the creative.	metric
leads_button_impression	The number of impressions of the leads generation button within the creative.	metric
leads_cpl	Cost Per Lead, the cost incurred for each lead generated.	metric
leads_cvr	Lead Conversion Rate, calculated as leads divided by clicks or impressions.	metric
like	The number of likes received on the creative or associated content.	metric
marketing_target	The marketing objective or target set for the campaign.	dimension
message	The number of messages sent or received in response to the creative.	metric
message_consult	The number of consultation messages initiated by users through the creative.	metric
message_consult_cpl	Cost Per Lead for message consultations, calculated as cost divided by the number of message consultations.	metric
message_user	The number of unique users who sent messages after interacting with the creative.	metric
msg_leads_cost	The cost incurred for leads generated through messages.	metric
msg_leads_num	The number of leads generated through messages.	metric
optimize_target	The optimization goal set for the creative or campaign.	dimension
page_id	Unique identifier for the page associated with the creative.	dimension
phone_call_cnt	The number of phone calls initiated after interacting with the creative.	metric
phone_call_succ_cnt	The number of successful phone calls initiated after interacting with the creative.	metric
pic_save	The number of times the creative image was saved by users.	metric
placement	The placement where the creative was displayed (e.g., feed, story).	dimension
promotion_target	The specific target of the promotion (e.g., app, landing page).	dimension
province	The province where the ad impression or interaction occurred.	dimension
roi	Return on Investment, a performance measure used to evaluate the efficiency of an investment.	metric
screenshot	The number of times users took a screenshot of the creative.	metric
seller_visit	The number of visits to the seller’s profile or store after interacting with the creative.	metric
seller_visit_price	The total price of goods from seller visits after interacting with the creative.	metric
share	The number of times the creative was shared by users.	metric
shopping_cart_add	The number of times an item was added to the shopping cart after interacting with the creative.	metric
success_goods_order	The number of successful orders placed for goods after interacting with the creative.	metric
time	The timestamp or reporting period for the data.	dimension
unit_id	Unique identifier for the ad unit.	dimension
unit_name	Name of the ad unit.	dimension
valid_leads	The number of valid leads generated by the creative.	metric
valid_leads_cpl	Cost Per Valid Lead, the cost incurred for each valid lead generated.	metric
video_play_5s_cnt	The number of times the video creative was played for at least 5 seconds.	metric
video_play_5s_rate	The rate at which the video creative was played for at least 5 seconds, calculated as video plays for 5s divided by video impressions.	metric