管理员报表API

管理员报表API

更新时间:2018-04-20 13:51:16

该API描述管理员操作报表功能。

具体域名请联系阿里云营销引擎技术支持获取。

API调用实例

API调用路径以及参数介绍

DSP整体交易报表(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_list/${start_time}/${end_time}?type=${type}&page=${page}&size=${size}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
type int N 交易类型(1:充值;2:消费;3:退款)
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_list/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
type 交易类型 1:充值,2:消费,3:退款
date 操作日期
amount 金额

返回样例

JSON返回

  1. {
  2. "data": {
  3. "total": 2,
  4. "list": [{
  5. "date": "2017-01-04 00:00:00",
  6. "amount": 100,
  7. "type": 1
  8. }, {
  9. "date": "2017-01-04 00:00:00",
  10. "amount": 10,
  11. "type": 3
  12. }]
  13. },
  14. "result": "SUCCESS"
  15. }

dsp整体交易报表整体数据(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_sum/${start_time}/${end_time}?type=${type}&page=${page}&size=${size}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
type int N 交易类型(1:充值;2:消费;3:退款)
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_sum/2017-01-01/2017-01-07?page=1&size=10

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
amount 金额
type 交易类型(1:充值;2:消费;3:退款)

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "amount": 100,
  4. "type": 1
  5. }, {
  6. "amount": 10,
  7. "type": 3
  8. }],
  9. "result": "SUCCESS"
  10. }

dsp推广主交易报表(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_list/${start_time}/${end_time}?type=${type}&page=${page}&size=${size}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
type int N 交易类型(1:充值;2:消费;3:退款)
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_exchange_statement_list/2017-01-01/2017-01-07?page=1&size=10

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
type 交易类型(1:充值;2:消费;3:退款)
date 操作日期
amount 金额
advertiserId 推广主ID

返回样例

JSON返回

  1. {
  2. "data": {
  3. "total": 2,
  4. "list": [{
  5. "date": "2017-01-04 00:00:00",
  6. "amount": 100,
  7. "type": 1,
  8. "advertiserId": 1000006
  9. }, {
  10. "date": "2017-01-04 00:00:00",
  11. "amount": 10,
  12. "type": 3,
  13. "advertiserId": 1000006
  14. }]
  15. },
  16. "result": "SUCCESS"
  17. }

dsp媒体效果报表趋势(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_statement/${start_time}/${end_time}?media_category=${media_category}&page=${page}&size=${size}&media_type=${media_type}&media_id=${media_id}&pid=${pid}&hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
media_category string N 媒体资源位分类名称(urlencoding后传输),见附录字典
media_type string N 媒体类型名称(PC;APP;移动网页),(中文urlencoding后传输)
third_party_type int N 第三方类型(1:阿里妈妈Tanx;2:二方媒体;3:百度流量交易服务(Baidu Exchange Service);4:腾讯广告实时交易平台(Tencent AdExchange);5:Google DoubleClick)
media_id long N 媒体id多值列
pid long N 推广位id
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_statement/2017-06-12/2017-09-12

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
adv_expend 推广主消耗金额(元)
download_num 有效下载数
total_download_num 所有下载数
total_conversion_num 所有转化数
statement_time 报表日期
total_show_num 所有展示数
total_click_num 所有点击数
media_pv 媒体PV
clicks 有效点击数
conversion_num 有效转化数
request_creative_num 请求创意总数
return_creative_num 返回创意总数

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "adv_expend": 3.2,
  4. "download_num": 140,
  5. "total_download_num": 223,
  6. "total_conversion_num": 327,
  7. "statement_time": "2016-11-01 00:00:00",
  8. "total_show_num": 8145,
  9. "total_click_num": 6,
  10. "media_pv": 7050,
  11. "clicks": 5,
  12. "conversion_num": 250,
  13. "request_creative_num": 25,
  14. "return_creative_num": 25
  15. }, {
  16. "adv_expend": 6.4,
  17. "download_num": 280,
  18. "total_download_num": 446,
  19. "total_conversion_num": 654,
  20. "statement_time": "2016-11-02 00:00:00",
  21. "total_show_num": 14690,
  22. "total_click_num": 12,
  23. "media_pv": 10100,
  24. "clicks": 10,
  25. "conversion_num": 500,
  26. "request_creative_num": 25,
  27. "return_creative_num": 25
  28. }],
  29. "result": "SUCCESS"
  30. }

dsp媒体效果详细数据(GetDspMediaStatementDetailRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/statistics/media/query/${start_time}/${end_time}?${media_type}=${media_type}&third_party_type=${third_party_type}&media_id=${media_id}&pid=${pid}&hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
media_category string N 媒体资源位分类名称(urlencoding后传输),见附录字典
media_type string N 媒体类型名称(PC;APP;移动网页),(中文urlencoding后传输)
third_party_type int N 第三方类型(1:阿里妈妈Tanx;2:二方媒体;3:百度流量交易服务(Baidu Exchange Service);4:腾讯广告实时交易平台(Tencent AdExchange);5:Google DoubleClick)
media_id long N 媒体id多值列
pid long N 推广位id
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/statistics/media/query/2017-06-29/2017-08-22

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
media_name 媒体名称
site_name 推广位名称
media_type 媒体类型
media_category 媒体下推广位类目
media_domain 媒体域名
third_party_type 第三方类型(1:阿里妈妈Tanx;2:二方媒体;3:百度流量交易服务(Baidu Exchange Service);4:腾讯广告实时交易平台(Tencent AdExchange);5:Google DoubleClick)
adv_expend 推广主消耗金额(元)
download_num 有效下载数
total_download_num 所有下载数
total_conversion_num 所有转化数
statement_time 报表日期
total_show_num 所有展示数
total_click_num 所有点击数
media_pv 媒体PV
clicks 有效点击数
conversion_num 有效转化数
request_creative_num 请求创意总数
return_creative_num 返回创意总数

返回样例

JSON返回

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "list": [{
  5. "clicks": 1,
  6. "media_name": "测试-媒体-PC",
  7. "site_name": "abc",
  8. "media_type": "PC",
  9. "media_category": "美食",
  10. "media_domain": "www.taobao.com",
  11. "media_pv": 1,
  12. "adv_expend": 0.062,
  13. "statement_time": "2017-01-11 22:00:00",
  14. "third_party_type": 1,
  15. "download_num": 0,
  16. "conversion_num": 0,
  17. "total_show_num": 1,
  18. "total_click_num": 1,
  19. "total_download_num": 0,
  20. "total_conversion_num": 0,
  21. "request_creative_num": 5,
  22. "return_creative_num": 2
  23. }],
  24. "total": 1
  25. }
  26. }

dsp效果报表数据趋势(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_effect_statement_list/${start_time}/${end_time}?hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_effect_statement_list/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
show_num 有效展示数
download_num 有效下载数
total_download_num 所有下载数
total_conversion_num 所有转化数
statement_time 报表时间
ad_cost 消耗金额(元)
total_show_num 所有展示数
total_click_num 所有点击数
Clicks 有效点击数
conversion_num 有效转换数

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "show_num": 4500000000,
  4. "download_num": 120006,
  5. "total_download_num": 120006,
  6. "total_conversion_num": 34567,
  7. "statement_time": "2016-12-08",
  8. "ad_cost": 4300000,
  9. "total_show_num": 560000000,
  10. "total_click_num": 5100000,
  11. "clicks": 3100000,
  12. "conversion_num": 20306
  13. }],
  14. "result": "SUCCESS"
  15. }

dsp效果报表数据整体数据(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_effect_statement_sum/${start_time}/${end_time}?hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_effect_statement_sum/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
show_num 有效展示数
download_num 有效下载数
ad_cost 消耗金额(元)
clicks 有效点击数
conversion_num 有效转换数

返回样例

JSON返回

  1. {
  2. "data": {
  3. "show_num": 102500124310,
  4. "download_num": 1900126,
  5. "ad_cost": 114601141.45,
  6. "clicks": 50800129,
  7. "conversion_num": 323020
  8. },
  9. "result": "SUCCESS"
  10. }

dsp整体效果报表Top10消耗推广方(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_advertiser_top/${start_time}/${end_time}?hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_advertiser_top/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
company_name 公司名称
id 公司id

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "company_name": "perl inc.",
  4. "id": "1"
  5. }, {
  6. "company_name": "阿里云",
  7. "id": "2"
  8. }],
  9. "result": "SUCCESS"
  10. }

dsp整体效果报表Top10消耗媒体(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_top/${start_time}/${end_time}?hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_top/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
adv_expend 消耗金额(元)
media_name 媒体名称
media_domain 媒体域名
third_party_type 第三方类型(1:阿里妈妈Tanx;2:二方媒体;3:百度流量交易服务(Baidu Exchange Service);4:腾讯广告实时交易平台(Tencent AdExchange);5:Google DoubleClick)

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "adv_expend": 25.63,
  4. "third_party_type": 2,
  5. "media_name": "测媒",
  6. "media_domain": "www.aliyun.com"
  7. }, {
  8. "adv_expend": 9.6,
  9. "third_party_type": 2,
  10. "media_name": "新博",
  11. "media_domain": "xinbo.com"
  12. }],
  13. "result": "SUCCESS"
  14. }

dsp整体效果报表Top10消耗媒体类目(GetDspStatementRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_category_top/${start_time}/${end_time}?hour=${hour}

参数列表

参数 类型 必填 描述
start_time string Y 开始时间(yyyy-mm-dd)
end_time string Y 结束时间(yyyy-mm-dd)
hour boolean Y 是否是24小时报表(false:不是,true:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/dspstatement/query/dsp_media_category_top/2017-01-01/2017-01-07

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
adv_expend 消耗金额(元)
media_category 资源位类别名称

返回样例

JSON返回

  1. {
  2. "data": [{
  3. "adv_expend": 35.2,
  4. "media_category": "娱乐"
  5. }, {
  6. "adv_expend": 0.657,
  7. "media_category": "休闲娱乐"
  8. }],
  9. "result": "SUCCESS"
  10. }