Dashboard数据报表相关接口
所有文档

          Cloud DSP

          Dashboard数据报表相关接口

          基本概念

          指标

          指标是用户(本文中用户既可以是dsp方,也可以是广告主)关心的数据,对于每次报表查询,返回的指标都是相同的。指标参考下表:

          指标名 含义 类型
          request 请求次数 BIGINT
          bid 竞价次数 BIGINT
          imp 展现次数 BIGINT
          click 点击次数 BIGINT
          download 下载次数 BIGINT
          cost 消费金额 BIGINT
          revenue 收入 BIGINT
          click_ratio 点击率 FLOAT
          cpm 平均千次展现费用 FLOAT
          cpc 平均点击费用 FLOAT

          维度

          维度是用户每次查询时查看指标的筛选条件,用户可以指定不同的维度进行查询。维度参考下表:

          维度名 含义 类型
          date 报表日期,以天为粒度 DATE
          part 报表日期,以小时为粒度 DATETIME
          user_id 广告主ID BIGINT
          plan_id 计划ID BIGINT
          unit_id 单元ID BIGINT
          idea_id 创意ID BIGINT
          ad_bid_type 广告竞价类型 INT
          adx ADX类型 INT
          creative_type 创意类型 INT
          prov 省份 VARCHAR
          city 城市 VARCHAR
          adview_type 流量类型(0 – web, 1 – wap, 2- app) INT
          site 站点 VARCHAR
          os 操作系统 INT
          carrier 运营商 INT
          device 设备类型 INT

          报表查询接口

          请求

          方法 URI 说明
          POST /dashboard/v1/cluster/{clusterId}/dashboard 查询报表

          请求参数

          字段名 含义 类型
          groupBy 分组查询,同MySql语义 List
          offset 从{offset}条开始返回,同MySql语义,(默认值0)建议使用offset时一定要带上ordeBy INT
          limit 返回条目数,同MySql语义(默认值20) INT
          orderBy 按字段排序,同MySql语义 String
          order asc-升序,desc-降序,默认desc String
          filter 过滤条件,类似sql中where语义 List

          filter格式

          {
           [
           {target}: targetVal
           {target}Max: targetMaxVal
           {target}Min: targetMinVal
           ]
          }

          filter中target需要被替换为指标或维度字段名。上述filter语句等同于sql中 where {target} = targetVal and {target} < targetMaxVal and {target} >= targetMinVal

          响应

          返回值为一个List

          示例

          请求示例

          POST /dashboard/v1/cluster/dsp-exz6OvJdSNpJpQyu/dashboard HTTP/1.1
          User-Agent: Fiddler
          Host: clouddsp.bj.baidubce.com
          Content-Length: 73
          X-Bce-Account: testUser
          Content-Type: application/json
          
          { "filter":[{"fieldMax":"date", "fieldMaxValue":"2017-04-30 14:00:00"}]}

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "data": [
                  {
                      "date": 1492963200000,
                      "part": 1493002695000,
                      "userId": 2,
                      "planId": 1,
                      "unitId": 1,
                      "ideaId": 1,
                      "adBidType": "CPC",
                      "adx": "BCH",
                      "creativeType": "IMAGE",
                      "prov": "1",
                      "city": "1",
                      "adviewType": "WAP",
                      "site": "1",
                      "os": "MAC",
                      "carrier": "YIDONG",
                      "device": "PHONE",
                      "request": 2000,
                      "bid": 800,
                      "imp": 100,
                      "click": 10,
                      "download": 1,
                      "cost": 100,
                      "revenue": 120,
                      "clickRatio": 0.1,
                      "cpm": 1000,
                      "cpc": 10
          	     }
              ]
          }

          下载报表

          请求

          方法 URI 说明
          POST /dashboard/v1/cluster/{clusterId}/dashboard/file 下载报表

          请求参数

          字段名 含义 类型
          groupBy 分组查询,同MySql语义 List
          offset 从{offset}条开始返回,同MySql语义,(默认值0)建议使用offset时一定要带上ordeBy INT
          limit 返回条目数,同MySql语义(默认值20) INT
          orderBy 按字段排序,同MySql语义 String
          order asc-升序,desc-降序,默认desc String
          filter 过滤条件,类似sql中where语义 List

          响应

          返回CSV格式的DashBoard列表文件

          示例

          请求示例

          POST /dashboard/v1/cluster/dsp-exz6OvJdSNpJpQyu/dashboard/file HTTP/1.1
          User-Agent: Fiddler
          Host: clouddsp.bj.baidubce.com
          Content-Length: 73
          X-Bce-Account: testUser
          Content-Type: application/json
          
          { "filter":[{"fieldMax":"date", "fieldMaxValue":"2017-04-30 14:00:00"}]}

          根据查询条件查询报表

          请求

          方法 URI 说明
          POST /dashboard/v1/cluster/{clusterId}/dashboard/metric 根据查找条件查询报表

          请求参数

          字段名 含义 类型 是否必选
          groupBys 分组查询,同MySql语义 String[] 可选
          metrics 分组查询字段 String[] 可选
          userId 广告主id Long 可选
          planIds 广告计划id集合 Long[] 可选(如果不设置,则查询所有广告计划)
          unitIds 广告单元id集合 Long[] 可选(如果不设置,则查询所有广告单元)
          orderBys 字段排序集合 String[] 必选(如果groupBys或metrics不为空,orderBys必须取值groupBys或metrics里面的元素)
          startDay 开始投放时间(天级别,格式为yyyy-MM-dd) String 必选
          endDay 结束投放时间(天级别,格式为yyyy-MM-dd) String 必选
          pageNo 分页查询第几页 int 可选(默认值为1)
          pageSize 返回条目数,同MySql语义(默认值20) int 可选
          order asc-升序,desc-降序,默认desc String 可选

          响应

          返回List,指标列表。

          示例

          请求示例

          POST  /dashboard/v1/cluster/dsp-exz6OvJdSNpJpQyu/dashboard/metric HTTP/1.1
          User-Agent: Fiddler
          Host: clouddsp.bj.baidubce.com
          Content-Length: 73
          X-Bce-Account: testUser
          Content-Type: application/json
          
          {
          	"metrics": ["imp", "click", "request"],
          	"groupBys":["user_id", "unit_id", "plan_id"],
          	"endDay": "2017-06-17",
          	"startDay": "2017-06-17",
          	"orderBys":["plan_id"],
          	"order":"desc",
          	"userId": 1000
          }

          返回示例

          {
              "data": [
                  {
                      "userId": 1000,
                      "planId": 4,
                      "unitId": 5,
                      "imp": 212356,
                      "click": 7271,
                      "request": 13965229
                  }
              ]
          }

          根据查询条件查询记录数量

          请求

          方法 URI 说明
          POST /dashboard/v1/cluster/{clusterId}/dashboard/num 根据查找条件查询记录数量

          请求参数

          字段名 含义 类型 是否必选
          groupBys 分组查询,同MySql语义 String[] 可选
          metrics 分组查询字段 String[] 可选
          userId 广告主id Long 可选
          planIds 广告计划id集合 Long[] 可选(如果不设置,则查询所有广告计划)
          unitIds 广告单元id集合 Long[] 可选(如果不设置,则查询所有广告单元)
          orderBys 字段排序集合 String[] 必选(如果groupBys或metrics不为空,orderBys必须取值groupBys或metrics里面的元素)
          startDay 开始投放时间(天级别,格式为yyyy-MM-dd) String 必选
          endDay 结束投放时间(天级别,格式为yyyy-MM-dd) String 必选
          pageNo 分页查询第几页 int 可选(默认值为1)
          pageSize 返回条目数,同MySql语义(默认值20) int 可选
          order asc-升序,desc-降序,默认desc String 可选

          响应

          返回指标记录数。

          示例

          请求示例

          POST  /dashboard/v1/cluster/dsp-exz6OvJdSNpJpQyu/dashboard/num HTTP/1.1
          User-Agent: Fiddler
          Host: clouddsp.bj.baidubce.com
          Content-Length: 73
          X-Bce-Account: testUser
          Content-Type: application/json
          
          {
          	"metrics": ["imp", "click", "request"],
          	"groupBys":["user_id", "unit_id", "plan_id"],
          	"endDay": "2017-06-17",
          	"startDay": "2017-06-17",
          	"orderBys":["plan_id"],
          	"order":"desc",
          	"userId": 1000
          }

          返回示例

          {
              "data": 1
          }
          上一篇
          Finance财务相关接口
          下一篇
          Console集群管理相关接口