AppLovin Support

Web Reporting API

使用此 Reporting API 获取 JSON 或 CSV 格式的聚合 Web 广告活动数据。

此端点允许您指定归因模式。

请求格式

通过向以下基础 URL 发送 HTTP GET 请求来发起报表请求:

  • https://r.applovin.com/webReport

必需参数

参数用途
api_key您的 Report Key
您可以在 AppLovin dashboard 上找到您的 Report Key,方法是点击 dashboard 右上角的账户并选择 Keys。
start1报表的开始日期
接受 «YYYY-MM-DD» 格式的日期或 Unix 时间戳。例如,2012-10-05 或 1336608000。
end1报表的结束日期
接受 «YYYY-MM-DD» 格式的日期或 Unix 时间戳。例如,2012-10-05、1336608000 或 now。
format报表的格式
接受 json 或 csv。
columns报表的列列表(以逗号分隔)
请参阅下方允许的列。例如,day,campaign。
report_typeadvertiser(必需)
attribution_mode报表的归因模式
接受 click(仅限 click-through 归因)或 click_and_view(click-through 和 view-through 归因)。

1 此 API 的请求窗口为 90 天。请确保日期参数在过去 90 天内。

可选参数

参数用途
day_column默认情况下,指标是实时的;当您想要拉取 cohort 下的指标时,请将其设置为 day(指标会归因回投放时间)。
limit返回的行数限制;例如,500
offset开始获取行的偏移量;例如,100
having允许对数值进行复杂的过滤。
此参数接受 URL 编码的数值列、比较运算符和逻辑运算符,例如:impressions%20%3E%200%20AND%20cost%20%3E%200("impressions > 0 AND cost > 0")。
注意:这会减慢响应速度并增加超时的可能性。
not_zero将此项设置为 1 以过滤掉所有数值指标均为 0 的结果。

推荐列

列名包含内容
campaign广告活动名称
campaign_id_external广告活动的唯一引用
重命名广告活动时,此值不会改变。它与 {CAMPAIGN_ID} 点击宏的值相同。
cost广告主花费
country两位国家代码
creative_set创意组名称
creative_set_id创意组 ID。即使创意组名称发生变化,此 ID 也不会改变。
day报表数据日期
hour报表数据小时(仅适用于过去 30 天)

可选列

列名包含内容
ad_id广告 ID
audience_strategy广告活动受众优化策略(universal、prospecting 或 discovery)
average_cpc平均每次点击成本
campaign_bid_goalCPP 和 CPE 广告活动的广告活动 bid 目标,以美元值 ($) 表示。请求此列时,您还必须请求 campaign 列。
campaign_type广告活动优化类型(CPP、CPE 或 ROAS)
chka_usd_«x»1特定时间段内的总归因结账收入(«x» 为 0d、1d、3d、7d、14d、28d 之一)
clicks点击次数
cpp_«x»1特定时间段内的每次购买成本(«x» 为 0d、1d、3d、7d、14d、28d 之一)
ctr点击次数 ÷ impressions 数量
impressionsimpressions 数量
optimization_day_target您选择为广告活动定位的优化天数(例如,第 0 天或第 7 天)
placement_typeINTER、REWARDED_INTER 或 CTV
platformandroid、ios、fireos、tvos 或 ctv
roas_«x»1特定时间段内的总 ROAS(«x» 为 0d、1d、3d、7d、14d、28d 之一)
sales归因销售事件的数量
sales_«x»1特定时间段内的销售额(«x» 为 0d、1d、3d、7d、14d、28d 之一)

1时间段指定为自 impression 时间起的滚动窗口。0d 表示自 impression 时间起 24 小时内的事件,1d 表示 48 小时,3d 表示 96 小时,依此类推。

新客户数据列

列名包含内容
nc_d0_checkouts自 impression 起 24 小时内新客户进行的结账次数。
nc_d0_checkout_rev自 impression 起 24 小时内衡量的新客户总收入。
nc_d0_cpp花费除以新客户 D0 结账数。
nc_d0_roas新客户 D0 结账收入除以花费。
nc_percent_d0_checkouts新客户产生的 D0 结账百分比。
nc_percent_d0_checkout_rev新客户产生的 D0 结账收入百分比。
nc_d7_checkouts自 impression 起 192 小时内新客户进行的结账次数。
nc_d7_checkout_rev自 impression 起 192 小时内衡量的新客户总收入。
nc_d7_cpp花费除以新客户 D7 结账数。
nc_d7_roas新客户 D7 结账收入除以花费。
nc_percent_d7_checkouts新客户产生的 D7 结账百分比。
nc_percent_d7_checkout_rev新客户产生的 D7 结账收入百分比。
new_visitor_rate访问您网站的新访客百分比。

线索列

列名包含内容
generate_lead_«x»在给定时间段内产生至少一个线索的 impressions 数量(«x» 为 0d、1d、3d、7d、14d、28d 之一)。
cost_per_lead_«x»特定时间段内的花费除以线索数(«x» 为 0d、1d、3d、7d、14d、28d 之一)。
lead_roas_«x»特定时间段内产生的线索价值除以广告花费(«x» 为 0d、1d、3d、7d、14d、28d 之一)。

过滤列

您可以按任何列过滤报表。 执行此操作时,您将搜索与任何过滤器直接匹配的内容。

要按列进行过滤,请添加以下 URL 参数:filter_columnname=«onefilter,anotherfilter,thirdfilter»

例如,如果您只想查看 Android 平台的数据,请设置以下 URL 参数:filter_platform=Android

有关所有列的列表,请参阅上表。

某些列支持通过 filter_not_columnname=«onefilter,anotherfilter» 进行排除过滤。

排序列

您对报表进行排序的方式与过滤报表的方式类似。

例如,要按 campaign 对报表进行排序,请添加以下 URL 参数:sort_campaign=ASC

接受的值为 ASC(升序)或 DESC(降序)。 所有排序均为字典序排序。

报表格式

您可以请求两种格式的报表:JSON 或 CSV。

时区

Reporting API 中的所有数据均采用 UTC(协调世界时)。

示例请求

https://r.applovin.com/webReport?api_key=«your-report-key»&start=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser&attribution_mode=click

search