Ad Report API

1.Interface Instructions

Each page returns 2000 pieces of data by default
When requesting, the current page data is obtained through the auto-increment page parameter. When no data is returned, it means that all the data has been pulled.
Data update frequency: every 15-30 minutes
The time zones of the data returned by each media channel are as follows

Channel	Time Zone
Facebook	Ad Account Time Zone
Google	Ad Account Time Zone
TikTok	Ad Account Time Zone
Kwai	Ad Account Time Zone
Huawei(Global)	Ad Account Time Zone
Apple	UTC+0
Mintegral	UTC+0
AppLovin	UTC+0
Unity	UTC+0
ironSource	UTC+0
Vungle	UTC+0

2.Interface Path

POST https://xmp-open.nativex.com/v1/media/account/report

3.Request Parameters

Parameters	Type	Required	Instructions
client_id	string	Y	Please contact xmp account manager to know
timestamp	int	Y	unix timestamp when requested
sign	string	Y	md5(client_secret+timestamp)
start_date	string	Y	YYYY-MM-DD
end_date	string	Y	YYYY-MM-DD
media	string	Y	View Media Enumeration Value
dimension	array	N	Returns the ad account dimension data by default, example: [‘date’], optional values: date (date) geo (region) campaign_id (campaign id ) campaign (campaign name) adset_id (ad set id ) adset (ad set name) ad_id (ad id, returns asset level for google) ad (ad name, returns asset level for google) product_name ( xmp product name ) app_platform (app platform) store_package_id (store id ) Note: When querying xmp product dimension data, you need to bind and associate the ad set with the xmp product in the background
currency	string	N	Returns the currency of the advertising account on the media side if not passed, optional: CNY, USD, EUR (compatible with all lowercase)
page	int	Y	page

4.Request Example

{
  "client_id": "dev",
  "timestamp": 1608776690,
  "sign": "05d481dc241a7a1daa5b2a7fa2b51dc5",
  "start_date": "2021-01-01",
  "end_date": "2021-01-15",
  "dimension": [//非必填
    "date",
    "geo"
  ],
  "currency": "USD",//非必填
  "page": 1
}

5.Return Parameters

The result returned by the interface is a string in json format
The code, msg, data fields will be returned regardless of success or failure
If the value has no data, or is not divisible (when the denominator is 0, the numerator or the denominator does not exist), then return null

Parameter	Type	Instruction
code	int	see error codes
msg	string	message
data	array	returned interface content
data.list	array	returned data list
data.page	int	page

data.list Field

Parameter	Type	Instruction
date	string	date
media	string	media
account_id	string	account_id
geo	string	region
campaign_id	string	campaign id
campaign	string	campaign name
adset_id	string	ad set id
adset	string	ad set name
ad_id	string	ad id
ad	string	ad name
product_name	string	xmp product name
app_platform	string	app platform
store_package_id	string	store id
cost	float	cost
currency	string	Return according to the incoming currency, and return the currency of the ad account on the media side if it is not transmitted
impressions	int	impressions
clicks	int	clicks
conversions	int	conversions
activations	int	activations
purchases	int	purchase
ctr	string	click through rate
cpc	string	cost per click
ecpm	float	effective cost per mille
cvr	string	conversion rate
cost_per_conversions	float	cost per conversion
cost_per_purchase	float	cost per purchase
purchase_rate	string	purchase rate
cost_per_activation	float	cost per activation
activation_rate	string	activation rate

Field Formula

Parameter	Formula
ctr	clicks/impressions*100%
cpc	cost/click
ecpm	cost/impression*1000
cvr	conversions/clicks*100%
cost_per_conversions	cost/conversions
cost_per_purchase	cost/purchases
purchase_rate	purchases/activation*100%
cost_per_activation	cost/activations
activation_rate	activation/clicks*100%

Open API Protocol

Creative Library API

Last modified: 2024-09-13Powered by

Outline