Creative Report API

1. Interface Instruction

Data created by XMP material library and media material library can be queried. Support channels: OceanEngine, Tencent, Kwai, Facebook, Google, TikTok, Mintegral, Applovin, Unity
Update frequency: 1 hour
Limit the number of parallel queries to 5

2.Interface Path

POST https://xmp-open.nativex.com/v1/media/material_report/list

3.Request Parameters

Common request parameters: please refer to Open API Protocol

Parameter	Type	Required	Instruction
start_date	string	Y	YYYY-MM-DD
end_date	string	Y	YYYY-MM-DD, the longest span does not exceed 30 days
dimension	array	N	Fixed: material_name（creative name） md5_file_id（creative md5） Can be multiple selected additionally: date（date） media（media channel） account_id（ad account id） account_name（ad account name） campaign_id（campaign id） campaign_name（campaign name） adset_id（ad set id） adset_name（ad set name） ad_id（ad id） ad_name（ad name） Can be multiple selected additionally: placement（ad placement） geo（location）
md5_file_id	array	N	creative md5
media	array	N	View Media Enumeration Value
account_id	array	N	ad account id
geo	array	N	location, only valid when queried by location dimension eg. CN
report_type	int	N	Display the full creative report data by default, options: 1- Full creative reports 2- Only creative reports created by xmp creative library 3-Only creative reports created by media creative library
cost_currency	string	Y	currency, options: cny、usd、eur
page	int	N	current page, the default is 1
page_size	int	N	page size, the default is 200, 1~1000 is available

4.Request Example

{
    "client_id": "xxx",
    "timestamp": 1608776690,
   "sign": "05d481dc241a7a1daa5b2a7fa2b51dc5",
    "start_date": "2021-12-01", #required
    "end_date": "2021-12-27",   #required
    "dimension": [
        "date",
        "geo",
        "material_name"
    ],
    "md5_file_id": [],
    "media": [],
    "account_id": [],
    "geo": ["google"],
    "report_type": 2,
    "cost_currency": "usd" #required
}

5.Return Parameters

First-level Parameter	Second-level Parameter	Type	Instruction
code	–	int	error code
msg	–	string	message
data	–	array	returned interface content
data.list	–	array	returned interface content
–	material_name	string	creative name, fixed dimension. When the creative md5 corresponds to multiple creative names, the creative with the latest creation time is returned.
–	md5_file_id	string	creative md5, fixed dimension.
–	date	string	date, dimension returns only if date is passed
–	media	string	media channel, dimension returns only if media is passed
–	placement	string	ad placement, dimension returns only if placement is passed
–	geo	string	location, dimension returns only if geo is passed
–	account_id	string	ad account id, dimension returns only if account_id is passed
–	account_name	string	ad account name, dimension returns only if account name is passed
–	campaign_id	string	campaign id, dimension returns only if campaign_id is passed
–	campaign_name	string	campaign name, dimension returns only if campaign_name is passed
–	adset_id	string	ad set id, dimension returns only if adset_id is passed
–	adset_name	string	adset_name, dimension returns only if adset_name is passed
–	ad_id	string	ad id, dimension returns only if ad_id is passed
–	ad_name	string	ad name, dimension returns only if ad_name is passed
–	currency_cost	float	cost
–	impression	int	impression
–	click	int	click
–	conversion	int	conversion
–	video_play	int	The number of playbacks only returned when creative type is video
–	video_play_p25	int	The number of 25% playbacks only returned when creative type is video
–	video_play_p50	int	The number of 50% playbacks only returned when creative type is video
–	video_play_p75	int	The number of 75% playbacks only returned when creative type is video
–	video_play_p100	int	The number of 100% playbacks only returned when creative type is video
data.page	–	int	page
–	page	int	current page
–	page_size	int	page size
–	next_page	int	1 for there is a next page, 0 for there isn’t a next page.

6.Return Example

{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "account_id": "163945470",
                "account_name": "test Tiles 3",
                "ad_id": "170351896",
                "ad_name": "test-sj_001",
                "adset_id": "17035189803",
                "adset_name": "test_0425-2",
                "campaign_id": "17035189",
                "campaign_name": "test_b1063",
                "click": 3664,
                "conversion": 0,
                "currency_cost": 1140.17,
                "date": "2021-12-27",
                "geo": "US",
                "impression": "246274",
                "material_name": "",
                "md5_file_id": "cba8ad2580e296fe6249eac8b1046c8e",
                "media": "tiktok",
                "video_play": 0,
                "video_play_p100": 0,
                "video_play_p25": 0,
                "video_play_p50": 0,
                "video_play_p75": 0
            }
        ],
        "page": {
            "page": 1,
            "page_size": 1,
            "next_page":1
        }
    }
}

Creative Library API

Ad & Creative Mapping API

Last modified: 2024-09-13Powered by

Outline