跳至主要内容

全球统计应用程序接口

本节介绍全局统计 API 请求参数和结果数据。

注意：统计 API 路由已重新命名：

  • /statistics/advertiser/... -> /statistics/a/...
  • /statistics/publisher/... -> /statistics/p/...

注意：全球统计 API 仅显示跳过的日期、站点、区域、国家、地区和子 ID 的 RTB 查询。

参数说明说明类型
计数只返回结果总数。整数可选的
详尽如果可能，请提供更多细节。整数可选的
时区小时 "过滤器和 "group_by "的时区设置字符串可选的
总数表示是否在回复中添加总数。整数可选的
过滤限制统计查询返回值的过滤器反对可选的
分组在数据中应用的分组值列表。最多允许四个。矩阵强制性的
order_by按特定字段对结果排序。最多允许两个。矩阵可选的
预测用户希望在响应中返回的各个子结构。矩阵可选的
限额在此响应中返回的记录数。整数可选的
胶印检索记录的位置。整数可选的

参数计数​

财产计数
类型可选的
变量类型整数
默认值0
可用值[0, 1]
说明只返回结果总数。

例如​


    {
        "count": 1
    }

详细参数​

财产详尽
类型可选的
变量类型整数
默认值0
可用值[0, 1]
说明是否返回详细信息。

例如​


    {
        "detailed": 1
    }

参数时区​

小时 "过滤器和 "group_by "的时区设置。

财产时区
类型可选的
变量类型字符串
默认值美国/纽约
可用值设置/集合/时区的时区字段
说明注意：时区只有在我们根据小时数据进行查询时才有意义，对于非小时数据，这是一个无用选项。

例如​


    {
        "timezone": "Europe/Dublin"
    }

参数总数​

财产总数
类型可选的
变量类型整数
默认值0
可用值[0,1]
说明表示是否在回复中添加总数。

例如​


    {
        "totals": 1
    }

参数过滤器​

财产过滤
类型可选的
变量类型反对
广告商的可用选项["adblock", "advertiser_ad_type_id", "browser_id", "carrier_id", "category_id", "country_iso", "date_from", "date_to", "device_id", "device_type_id", hour", "language_id"、"operating_system_id"、"regional_id"、"site_hostname"、"site_id"、"size"、"sub"、"zone_id"、"campaign_id"、"exclude_deleted"、"offer_id"、"offer_landing_page_id"、"variation_id"]
出版商的可用选项[”adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “zone_id”, “publisher_ad_type_id”, “size”, “sub”]
说明根据某些参数进行筛选。

过滤器: country_iso​

财产country_iso
类型可选的
变量类型字符串
默认值-
可用值参见 /collections/countries endpoint iso3 属性
说明ISO 3 编码列表

例如​


    {
        "filter": {
            "country_iso": ["ESP", "IRL"]
        }
    }

筛选 "日期从"、"日期到"。​

日期从 "和 "日期到 "参数可控制获取统计信息的窗口。

  • date_from：统计数据的日期范围(默认为月初)、
  • date_to：统计的日期范围，(默认为今天)
财产起始日期、终止日期
类型可选的
变量类型字符串
默认值日期默认为当前月份。
可用值年-月-日
说明统计的日期起始/终止范围。格式 YYYY-mm-dd

例如​


{
        "filter": {
            "date_from": "2019-02-25",
            "date_to": "2019-02-28"
        }
}

时区只有在我们根据小时数据进行查询时才有意义，对于非小时数据来说，这是没有用的。

筛选器：advertiser_ad_type_id、campaign_id、browser_id、carrier_id、category_id、device_id、device_type_id、language_id、offer_id、offer_landing_page_id、operating_system_id、hour、region_id、site_id、sub、variation_id、zone_id、publisher_ad_type_id​

财产advertiser_ad_type_id、campaign_id、browser_id、carrier_id、category_id、device_id、device_type_id、language_id、offer_id、offer_landing_page_id、operating_system_id、hour、region_id、site_id、sub、variation_id、zone_id、advertiser_ad_type_id、publisher_ad_type_id
类型可选的
变量类型矩阵
项目类型整数
默认值-
可用值相对属性 OR 集合
说明实体编号列表

例如​


    {
        "filter": {
            "campaign_id": [123, 456],
            "browser_id": [789]
        }
    }

过滤器：exclude_deleted(排除已删除的内容​

财产排除删除
类型可选的
变量类型整数
默认值0
可用值[0, 1]
说明是否排除已删除的活动。

例如​


{
        "filter": {
            "exclude_deleted": 1
        }
}

过滤器：`adblock​

财产广告屏蔽
类型可选的
变量类型字符串
默认值"全部"
可用值"广告屏蔽"、"全部"、"标准"
说明是否包含广告屏蔽区。

例如​


    {
        "filter": {
            "adblock": "standard"
        }
    }

筛选器：site_hostname(网站主机名​

财产站点主机名
类型可选的
变量类型字符串
默认值-
可用值有效的主机名字符包括 a 至 z 的字母、0 至 9 的数字、连字符和点。
说明按站点主机名筛选。

例如​


        {
        "filter": {
            "site_hostname": ["www.example.com", "www.example-site.org"]
        }
    }

过滤器：`size​

财产尺寸
类型可选的
变量类型字符串
默认值-
可用值尺寸的有效字符为 0 至 9 的数字和 x 字符。例如 300x100
说明按尺寸筛选

例如​


           {
        "filter": {
            "size": ["300x100"]
        }
    }

参数 group_by​

财产分组
类型强制性的
变量类型矩阵
项目类型字符串
默认值-
广告商可用值["adblock", "advertiser_ad_type_id", "browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "date", "hour", "device_id", "device_type_id", "language_id"、"operating_system_id"、"region_id"、"site_id"、"sub"、"zone_id"、"week"、"month"、"quarter"、"year"、"offer_id"、"offer_landing_page_id"、"site_hostname"、"size"、"variation_id"]
出版商可用值[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “publisher_ad_type_id” “region_id”, “site_id”, “size”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”]
说明子请求列表，在回复中包含附加数据。

例如​


    {
      "group_by": [
        "browser",
        "date"
      ]
    }

参数 order_by​

财产order_by
类型可选的
变量类型矩阵
项目类型字符串
默认值-
可用指标字段值["cpc", "cpc", "cpm", "cpv", "ctr", "clicks", "impressions", "video_impressions", "video_views", "vtr", "rtb_win_ratio", "rtb_avg_total_time"、"rtb_skipped"、"rtb_bid_response_ratio"、"rtb_avg_cpm"、"rtb_timeouts_ratio"、"rt_errors_ratio"、"rtb_no_bid_ratio"、"rtb_skipped_ratio"]。
广告商的可用字段值取决于 `group_by["adblock", "browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "device_id", "date", "device_type_id", "hour", "ecpa1", "g1", "language_id"、月"、"offer_id"、"offer_landing_page_id"、"operating_system_id"、"quarter"、"region_id"、"site_hostname"、"site_id"、"sub"、"variation_id"、"week"、"year" , "zone_id"]
可用字段值取决于出版商的 `group_by'值[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]
可用订单值["asc"、"desc"]
说明可用订单选项列表

提示：

  • 指标字段始终可用，可用作排序字段。
  • 要按特定值(例如按 "browser_id")排序，需要在 "group_by "参数中加入该值。

g1"、"ecpa1 "值仅在用户使用转换跟踪(目标)时可用。所有目标都与序列号(g1、g2、...gx)相关联。eCPA 值相应为 ecpa1、ecpa2、...ecpax。

例如​


    {
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ]
    }

例如，要按时间顺序排列活动结果，"group_by "和 "order_by "中都需要包含 "日期"：


{
  "group_by": [
    "campaign_id",
    "date"
  ],
  "order_by":[
    {
      "field": "date",
      "order": "asc"
    }
  ]
}

参数投影​

投影参数反映了结果有效载荷中将返回的内容。如果未指定，将返回所有子结构。

财产预测
类型可选的
变量类型反对
项目类型矩阵
默认值所有选项，见下文
广告商可用字段值["基地"、"RTB"、"视频"、"目标*"]
出版商可用字段值["base"、"rtb"、"video"、"wpn"]

*有些 "目标 "字段，如 "利润 "和 "ROI"，是根据营销活动的成本计算的，因此，如果您想获得正确的 "目标 "指标，还必须使用 "基础 "字段。

例如​

为了获得作为广告商的所有可能指标，请使用：


    {
        "projection": {
          "base": ["*"],
          "video": ["*"],
          "goals": ["*"],
          "rtb": ["*"]
        }
    }

为了获得作为出版商的所有可能指标，请使用


    {
        "projection": {
          "base": ["*"],
          "video": ["*"],
          "wpn": ["*"],
          "rtb": ["*"]
        }
    }

您还可以在每个投影字段中指定度量指标：


    {
        "projection": {
          "base": ["impressions","clicks","cost","revenue","cpc","cpm","ctr"],
          "video": ["impressions","views","cpv","vtr"],
          "rtb": ["total_time","queries","value","success","no_bid","skipped","errors","timeouts","wins","win_ratio"],
          //only for Publishers
          "wpn": ["subscriptions","unsubscriptions","sent"]
        }
    }

唯一不允许进行具体度量预测的字段是 "目标"。

参数限制​

在此响应中返回的记录数。

财产限额
类型可选的
变量类型整数
默认值50

例如​


{
      "limit": 25
}

参数偏移​

检索记录的位置。

财产胶印
类型可选的
变量类型整数
默认值0

示例​


    {
      "offset": 150
    }

示例 1​

带过滤功能的广告系列统计。

请求：​


{
      "detailed": true,
      "totals": 1,
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["campaign_id"],
      "order_by": [
        {
          "field": "campaign_id",
          "order": "desc"
        }
      ]
      "projection": {
          "base": ["*"],
          "video": ["*"],
          "rtb": ["*"]
        },
      "limit": 2,
      "offset": 0
    }

回应：​


    {
      "request_metadata": {
        "count": 4,
        "limit": 2,
        "offset": 0
      },
      "result": [
        {
          "clicks": 0,
          "cost": 1.3302,
          "cpc": 0,
          "cpm": 0.45586017820425,
          "ctr": 0,
          "group_by": {
            "campaign_id": {
              "active": "1",
              "campaign_ad_type_name": "Popunders",
              "id": "1234567",
              "name": "Ron Mainstream Campaign "
            }
          },
          "impressions": 2918,
          "rtb": {
            "avg_cpm": 0.15582967823432,
            "avg_total_time": 89.522714492492,
            "errors": 112,
            "errors_ratio": 0.011368411650186,
            "no_bid": 870594,
            "no_bid_ratio": 88.368490823053,
            "queries": 985186,
            "response_ratio": 11.57101298638,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 984590,
            "timeouts": 484,
            "timeouts_ratio": 0.049127778916875,
            "total_time": 88196525,
            "value": 1776.396,
            "win_ratio": 0.29842080581738,
            "wins": 2940
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 18.1621655,
          "cpc": 0,
          "cpm": 1.8273634671496,
          "ctr": 0,
          "group_by": {
            "campaign_id": {
              "active": "1",
              "campaign_ad_type_name": "Popunders",
              "id": "7654321",
              "name": "Ron Mainstream Campaign Test"
            }
          },
          "impressions": 9939,
          "rtb": {
            "avg_cpm": 1.4753505300475,
            "avg_total_time": 88.777190144965,
            "errors": 46,
            "errors_ratio": 0.0014192869995779,
            "no_bid": 3209674,
            "no_bid_ratio": 99.031490893114,
            "queries": 3241064,
            "response_ratio": 0.8964340105595,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 3238728,
            "timeouts": 2290,
            "timeouts_ratio": 0.070655809326814,
            "total_time": 287732555,
            "value": 4286.48343,
            "win_ratio": 0.30665855410445,
            "wins": 9939
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        }
      ],
      "result_total": {
        "clicks": 0,
        "cost": 74.0473595,
        "cpc": 0,
        "cpm": 2.0864288391096,
        "ctr": 0,
        "impressions": 35490,
        "rtb": {
          "avg_cpm": 0.23441613972984,
          "avg_total_time": 87.995789332859,
          "errors": 539,
          "errors_ratio": 0.0049868154705264,
          "no_bid": 9771471,
          "no_bid_ratio": 90.405422546568,
          "queries": 10808501,
          "response_ratio": 9.5135301370653,
          "skipped": 0,
          "skipped_ratio": 0,
          "success": 10799741,
          "timeouts": 8221,
          "timeouts_ratio": 0.07606050089647,
          "total_time": 951102577,
          "win_ratio": 0.32861171035651,
          "wins": 35518
        },
        "video": {
          "cpv": 0,
          "impressions": 0,
          "views": 0,
          "vtr": 0
        }
      }
    }

示例 2​

当月按日期分列的广告客户统计信息，按印象排序。

请求：​

    {
      "group_by": ["date"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ]
      "projection": {
          "base": ["*"],
          "video": ["*"],
          "rtb": ["*"]
        }
    }
回应：​

    {
      "request_metadata": {
        "count": 3,
        "limit": 50,
        "offset": 0
      },
      "result": [
        {
          "clicks": 0,
          "cost": 624.2439917,
          "cpc": 0,
          "cpm": 1.0978015474007,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-02"
            }
          },
          "impressions": 568631,
          "rtb": {
            "avg_cpm": 0.31273156270632,
            "avg_total_time": 114.34705591799,
            "errors": 4143,
            "errors_ratio": 0.0076578188576312,
            "no_bid": 48085697,
            "no_bid_ratio": 88.8804144989,
            "queries": 54101567,
            "response_ratio": 10.971772776933,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 54021598,
            "timeouts": 75826,
            "timeouts_ratio": 0.14015490530986,
            "total_time": 6186354907,
            "value": 185634.35958,
            "win_ratio": 1.1633248996281,
            "wins": 629377
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 622.1688691,
          "cpc": 0,
          "cpm": 1.1800128762878,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-01"
            }
          },
          "impressions": 527256,
          "rtb": {
            "avg_cpm": 0.27775587567531,
            "avg_total_time": 118.91585420372,
            "errors": 2954,
            "errors_ratio": 0.0078196779097434,
            "no_bid": 32641750,
            "no_bid_ratio": 86.407573260111,
            "queries": 37776492,
            "response_ratio": 13.412992397494,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 37708708,
            "timeouts": 64830,
            "timeouts_ratio": 0.17161466448499,
            "total_time": 4492223815,
            "value": 140737.73563,
            "win_ratio": 1.4077723257099,
            "wins": 531807
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 441.843491,
          "cpc": 0,
          "cpm": 0.96186339096399,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-03"
            }
          },
          "impressions": 459362,
          "rtb": {
            "avg_cpm": 0.26462497173837,
            "avg_total_time": 116.9210100884,
            "errors": 2183,
            "errors_ratio": 0.0059889808787451,
            "no_bid": 32174177,
            "no_bid_ratio": 88.268681100486,
            "queries": 36450275,
            "response_ratio": 11.500815837466,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 36366256,
            "timeouts": 81836,
            "timeouts_ratio": 0.22451408116948,
            "total_time": 4261802971,
            "value": 110932.87869,
            "win_ratio": 1.2852029237091,
            "wins": 468460
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        }
      ]
    }

示例 3​

按日期和地区 ID 进行的出版商统计，按印象排序。

请求：


{
      "detailed": true,
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["date", "region_id"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ],
      "projection": {
        "base": ["*"],
        "video": ["*"],
        "wpn": ["*"],
        "rtb": ["*"]
      }
      "limit": 30,
      "offset": 0
    }

回应：


    {
      "request_metadata": {
        "count": 2,
        "limit": 30,
        "offset": 0
      },
      "result": [
        {
          "clicks": 3087,
          "cpc": 0.033842716164561,
          "cpm": 0.069188574849649,
          "ctr": 0.20444155402072,
          "group_by": {
            "date": {
              "date": "2019-03-11"
            },
            "region_id": {
              "country_iso": "USA",
              "country_long_name": "United States of America",
              "country_short_name": "United States",
              "id": 5332921,
              "name": "California"
            }
          },
          "impressions": 1494954,
          "revenue": 104.4724648,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.038451404048583,
            "impressions": 15013,
            "views": 2717,
            "vtr": 18.097648704456
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        },
        {
          "clicks": 3071,
          "cpc": 0.03151133555845,
          "cpm": 0.066658890819906,
          "ctr": 0.21153940205505,
          "group_by": {
            "date": {
              "date": "2019-03-10"
            },
            "region_id": {
              "country_iso": "USA",
              "country_long_name": "United States of America",
              "country_short_name": "United States",
              "id": 5332921,
              "name": "California"
            }
          },
          "impressions": 1436818,
          "revenue": 96.7713115,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.036216808196108,
            "impressions": 14921,
            "views": 2672,
            "vtr": 17.907646940554
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        }
      ]
    }

示例 4​

按站点 ID 进行出版商统计，并进行预测。

请求：​

{
      "detailed": true,
      "projection": {
        "base": ["*"],
        "video": ["*"],
        "wpn": ["*"],
        "rtb": ["*"]
      },
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["site_id"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ],
      "limit": 30,
      "offset": 0
    }
回应​

{
      "request_metadata": {
        "count": 2,
        "limit": 30,
        "offset": 0
      },
      "result": [
        {
          "clicks": 14320,
          "cpc": 0.028298959692737,
          "cpm": 0.057945765404939,
          "ctr": 0.20476288186597,
          "group_by": {
            "site_id": {
              "id": "11223344",
              "name": "nice-example.com"
            }
          },
          "impressions": 6916414,
          "revenue": 405.2411028,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.031519102652252,
            "impressions": 77041,
            "views": 12857,
            "vtr": 16.688516504199
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        },
        {
          "clicks": 14148,
          "cpc": 0.028769196296296,
          "cpm": 0.063791981699323,
          "ctr": 0.22173710048179,
          "impressions": 6314909,
          "revenue": 407.0265892,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.036406671663685,
            "impressions": 65620,
            "views": 11180,
            "vtr": 17.037488570558
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        }
      ]
    }