菜单

子账号综合报表

综合报表

注意:接入Api前请先熟悉api签名机制(参考接口鉴权说明), 即Api请求样例中的一些http请求头的来源

使用前说明

  • 申请开通报表API权限后:需要等大概等2到3小时左右才能获取到数据(否则数据列表是空,请耐心等待)

    (如何确认是否有权限:登录Taku后台,右上角下拉列表--账户管理--key页面,若有全局Publisher Key相应参数,则为已开通权限;若无,请联系Taku运营开通权限。)

  • 正常能获取到数据后,只能获取到申请子账号那天向前推1天之后的数据,比如2月24号申请子账号,只能获取到2月23号及之后日期的数据,否则获取不到收益相关数据(revenue, ecpm等)
  • 历史数据不会更新(除非当时数据不完整,重拉过数据),收益相关数据(revenue, ecpm等)延迟两天,即T+2延迟,topon统计数据(展示,点击)等每两小时更新一次,会比开发者后台延迟2到3小时左右

使用注意:

  • 当请求参数group_by中存在维度segment_id时,响应不返回api相关指标(ecpm,revenue)
  • 显示dau,deu条件:   

             (1) grouby条件必须只包含(一个或任意多个)以下维度:"date","app","geo_short","placement"

             (2) 如果grouby维度没有选中日期date,那么请求参数日期跨度必须只有一天,即start_date=end_date  

使用技巧:

  • 获取多个App数据:批量传入多个app_id,group by app_id即可
  • 获取多天数据:start_date和end_date传入一个时间段,group by date即可,由于数据更新不会很频繁,而且历史数据基本不会更新,建议每天更新最近2天数据就可以了
  • 数据汇总:group by到最细维度,可以拿到结果后再作sum计算

1 请求URL

https://openapi.toponad.com/v3/report/black/full

2 请求方式

POST

3 请求参数

字段

类型

是否必传

备注

样例

start_date

Int

Y

起始日期,格式:YYYYmmdd

20190501

start_date

Int

Y

起始日期,格式:YYYYmmdd

20190501

currency

String

Y

币种,指标revenue,ecpm等使用的币种可选:USD,CNY

 

app_id_list

Array[String]

N

应用ID列表,最大查询100个

[“a600e6fbeac98c”],

placement_id_list

Array[String]

N

广告位ID列表,最大查询100个

 

segment_id_list

Array[Int]

N

流量分组ID列表,最大查询100个

 

geo_short_list

Array[String]

N

国家短码列表,最大查询100个

[“US”,"CN"]

start

Int

N

偏移数,代表从第几条数据开始,默认为0

0

limit

Int

N

每次拉取数据的最大条数,默认是1000,最大1000,可选[1,1000]

 

group_by

Array[String]

N

group by 维度,不传时默认date维度,支持的维度说明:

date(日期),

app_id(应用ID),

placement_id(广告位ID),

segment_id(流量分组ID),

geo_short(国家短码),

["placement_id"]

metric

Array[String]

Y

想要返回的指标列表,至少选择一个指标,选择ecpm时,revenue也必须一起选择,枚举说明:

all(全部指标),

dau(DAU),

deu(DEU),

new_user(新用户数),

impression_rate(展示率),

impression(展示数),

click(点击数),

click_rate(点击率),

ecpm(ECPM),

revenue(收益),

load(流量请求数),

load_fill_rate(流量填充率),

 

 

4 响应参数

字段

类型

是否必传

备注

records

Array[Object]

N

记录,对象数组每个record结构见下面records元素结构,无数据时为空

count

Int

N

总条数,无数据时为空

 

records元素结构如下:

字段名

类型

是否必传

备注

date

Int

N

日期,格式:YYYYmmdd

load

Int

N

流量请求,注意:0时不返回

load_fill_rate

Float

N

流量填充率,注意:0时不返回

dau

Int

N

每天打开应用的独立用户数。注意:根据GDPR协议,欧盟地区需要用户同意后才会统计数据,注意:0时不返回

deu

Int

N

每天观看过广告的独立用户数。DAU仅支持应用维度,DEU支持应用、广告位、广告源3种维度,不同筛选条件下,DEU的数据会有所变化。注意:0时不返回

impression

Int

N

展示,注意:0时不返回

impression_rate

Float

N

展示率,注意:0时不返回

click

Int

N

点击,注意:0时不返回

click_rate

Float

N

点击率,注意:0时不返回

revenue

Float

N

收益,币种为请求参数的currency,注意:0时不返回

ecpm

Float

N

ecpm,注意:0时不返回

app_id

String

N

应用ID,group_by维度有选app_id才返回

app_name

String

N

应用名称,缓存时间6小时,group_by维度有选app_id才返回

placement_id

String

N

广告位ID,group_by维度有选placement_id才返回

placement_name

String

N

广告位名称,缓存时间6小时,group_by维度有选placement_id才返回

segment_id

Int

N

流量分组ID,group_by维度有选segment_id才返回

geo_short

Int

N

国家2字符短码,group_by维度有选geo_short才返回

5 样例

请求样例:

{
    "end_date": 20231212,
     "start_date": 20231212,
    "group_by": ["date","app_id"],
    "limit": 1000,
    "metric": ["all"],
    "currency":"USD",
    "start": 0
}

返回样例:

{
    "count": 1,
    "records": [
        {
            "date": 20231212,
            "loads": 208,
            "load_fill_rate": 0.99,
            "impression": 328,
            "impression_rate": 1.5769,
            "click": 14,
            "click_rate": 0.0426,
            "ecpm": 0.21,
            "dau": 106,
            "deu": 40,
            "new_user": 33,
            "revenue": 0.06,
            "app_id": "a63b688e08ab69"
        }
}

最近修改: 2025-05-30Powered by