透视报告终端

借助透视报告服务提供的 API，您可以获得不同来源的聚合数据，包括 KPI 服务指标、KPI 服务同期群、SKAdNetwork 和广告支出。

该报告终端可以在同一报告中结合多种服务数据。可请求按天、应用及广告渠道等查看安装、收入、广告支出以及 SKAdNetwork 数据。

调取透视报告

GET https://automate.adjust.com/reports-service/pivot_report

GET 方法以 JSON 格式返回来自报告服务的过滤数据。

过滤

过滤	类型	描述	示例
`dimensions`*	`String`	用于参数分类的值，用逗号隔开。详细信息请参考下面的表格。	`dimensions=app,os_name,week,campaign_id_network`
`metrics`*	`String`	用逗号隔开的 KPI。详细信息请参考下面的表格。	`metrics=cost,installs,ecpi_network`
`date_period`*	`String`	报告起始和截止日期，支持 3 种格式：逻辑日期绝对日期相对日期	逻辑日期： `this_month_until_yesterday` `today` `yesterday` `this_week` `last_week` `this_month` `last_month` 绝对日期： `2020-12-31:2021-01-01` 相对日期： `-10d:-3d (from 10 days ago to 3 days ago)`
`cohort_maturity`	`String`	`immature`: 展示所有同期群累积性指标的当前值，包括未成熟同期群。 `mature`: 只展示成熟同期群的累积性指标数据，未成熟同期群指标显示为零。	`cohort_maturity=immature`
`utc_offset`	`String`	报告中使用的时区。	`utc_offset=+01:00`
`attribution_type`	`String`	归因交互类型。 `click` (默认) `impression` `all`	`attribution_type=click`
`attribution_source`	`String`	应用内活动是分配给用户的安装来源(`first`)，还是分配给安装来源和后续再归因来源(`dynamic`)。默认为 `dynamic`。	`attribution_source=first`
`reattributed`	`String`	已被再归因用户的专属过滤器。当一名用户已经安装您的应用，但是又通过由 Adjust 跟踪的来源返回到应用，就会被再归因。 `all` (默认) `false` `true`	`reattributed=false`
`iap_revenue_mode`	`String`	终端返回的广告总收入百分比。可选项包括： `GROSS_100` `GROSS_85` `GROSS_70` `GROSS_60`	`iap_revenue_mode=GROSS_70`
`ad_revenue_sources`	`String`	用逗号隔开的广告收入来源列表。	`ad_revenue_sources=unknown`
`os_names`	`String`	用逗号隔开的操作系统名称列表。	`os_names=ios,android`
`ad_spend_mode`	`String`	指定计算中应用的广告支出。请阅读广告支出来源如何影响数据，了解更多信息。 `adjust` `network` `mixed`	`ad_spend_mode=network`
`sandbox`	`Boolean`	使用 sandbox 还是真实流量数据。默认为 `false`。	`sandbox=true`
`sort`	`String`	报告排序所用的指标/维度列表 (用逗号隔开)。使用 `-` 以降序排列。	`sort=-clicks,installs`
`drilldown`	`String`	细分数据所用的参数列表。格式：用竖线 (\|) 隔开的元组。	`drilldown=campaign:123\|adgroup:234`
`focus`	`String`	聚焦所用参数列表。格式为用竖线 (\|) 隔开的元组。与 drilldown 不同，不会向结果添加额外维度。	`focus=campaign:123\|adgroup:234`
`index`	`String`	报告索引所用的维度列表 (用逗号隔开)。	`index=network,campaign,adgroup`
`format_dates`	`Boolean`	如果设置为 `false`，则所有日期维度都将采用 ISO 格式。	`format_dates=false`
`period_over_period`	`String`	报告数据比较周期。	`period_over_period=previous_week`
`currency`	`String`	金额相关指标换算时所用的币种。	`currency=USD`
`[dimension]__in`	`String`	逗号隔开的值列表，用于任意维度的维度值过滤 (精准匹配)。	`campaign__in=abc,def`
`[dimension]__not_in`	`String`	逗号隔开的值列表，用于任意维度的维度值过滤 (排除精准匹配)。	`campaign__not_in=abc,def`
`[dimension]__contains`	`String`	任意维度的维度值子字符串搜索 (不区分大小写)。	`campaign__contains=ios`
`[dimension]__exclude`	`String`	任意维度的维度值子字符串排除搜索 (不区分大小写)。	`campaign__exclude=ios`
`[dimension]__starts_with`	`String`	带有指定前缀的维度值子字符串匹配搜索 (不区分大小写)。	`campaign__starts_with=ios`
`[dimension]__not_starts_with`	`String`	不带指定前缀的维度值子字符串匹配搜索 (不区分大小写)。	`campaign__not_starts_with=ios`
`[dimension]__ends_with`	`String`	带有指定后缀的维度值子字符串匹配搜索 (不区分大小写)。	`campaign__ends_with=ios`
`[dimension]__not_ends_with`	`String`	不带指定后缀的维度值子字符串匹配搜索 (不区分大小写)。	`campaign__not_ends_with=ios`
`[metric]__lt`	`String`	适用于任意指标的 “小于” 指标值过滤器。	`skad_installs__lt=100`
`[metric]__lte`	`String`	适用于任意指标的 “小于或等于” 指标值过滤器。	`skad_installs__lte=100`
`[metric]__gt`	`String`	适用于任意指标的 “大于” 指标值过滤器。	`skad_installs__gt=100`
`[metric]__gte`	`String`	指标的 “大于或等于” 指标值过滤器。	`skad_installs__gte=100`
`[metric]__eq`	`String`	适用于任意指标的 “等于” 指标值过滤器。	`skad_installs__eq=100`
`[metric]__ne`	`String`	适用于任意指标的 “不等于” 指标值过滤器。	`skad_installs__ne=100`

dimensions

通过维度，用户可以用一个或多个参数将指标细分为多个组。例如，您可以按照日期、国家/地区和渠道分别查看安装量。

维度	数据类型	描述	示例
`hour`	`Date`	使用 `format_dates=false` 返回 ISO 格式值。 `YYYY-MM-DDTHH:MM:SS`	`2021-05-11T17:00:45`
`day`	`Date`	使用 `format_dates=false` 返回 ISO 格式值。 `YYYY-MM-DD`	`2021-05-11`
`week`	`Date`	使用 `format_dates=false` 返回 ISO 格式值。 `YYYY-MM-DD - YYYY-MM-DD`	`2021-05-09 - 2021-05-15`
`month`	`Date`	使用 `format_dates=false` 返回 ISO 格式值。 `YYYY-MM`	`2021-05`
`year`	`Date`	使用 `format_dates=false` 返回 ISO 格式值。 `YYYY`	`2021`
`quarter`	`String`	使用 `format_dates=false` 返回 ISO 格式值。 `Q<quarter_number> YYYY`	`Q2 2021`
`os_name`	`String`	可能值： `android` `bada` `blackberry` `ios` `linux` `macos` `server` `symbian` `unknown` `webos` `windows` `windows-phone`
`device_type`	`String`	可能值： `bot` `console` `ipod` `mac` `pc` `phone` `server` `simulator` `tablet` `tv` `unknown`
`app`	`String`	应用名称。
`app_token`	`String`	Adjust 中的应用 ID。
`store_id`	`String`	商店应用 ID。	`com.random.app`
`store_type`	`String`	应用安装来源商店。	`google_play`
`currency`	`String`	币种名称。	`Euro`
`currency_code`	`String`	3 字符 ISO 4217 值。	`EUR`
`network`	`String`	广告渠道的名称。	Organic, AppLovin, Facebook Installs, Instagram Installs.
`campaign`	`String`	跟踪链接子层级 1。字符串值中一般包含推广活动名称和 ID。
`campaign_network`	`String`	渠道的推广活动名称。
`campaign_id_network`	`String`	渠道的推广活动 ID。
`adgroup`	`String`	跟踪链接子层级 2。字符串值中一般包含广告组名称和 ID。
`adgroup_network`	`String`	渠道的广告组名称。
`adgroup_id_network`	`String`	渠道的广告组 ID。
`source_network`	`String`	来源渠道名称。基于渠道的可选值。
`source_id_network`	`String`	来源渠道 ID
`creative`	`String`	跟踪链接子层级 3。字符串值中一般包含素材名称和 ID。
`creative_network`	`String`	渠道素材名称。
`creative_id_network`	`String`	渠道素材 ID。
`country`	`String`	国家/地区名称。	`United States of America`
`country_code`	`String`	2 字符 ISO 3166 值。	`US`
`region`	`String`	业务地区。	`APAC`
`partner_name`	`String`	Adjust 系统中的合作伙伴名称。	`AppLovin`
`partner_id`	`String`	Adjust 系统中的合作伙伴 ID。	`34`
`partner`	`String`	合作伙伴唯一 slug。	`applovin`
`channel`	`String`	`partner_name`和`network`的组合。
`platform`	`String`	设备运行的系统/平台。请在下表中查看所有受支持的平台。	`android`

平台

android
android-tv
bada
blackberry
facebook
fire-tv
ios
linux
macos
server
symbian
webos
windows
windows-phone

metrics

指标用于评估和比较您通过 Adjust 开展和监测的推广活动表现。

每个 API 请求须带有至少 1 个指标。最常用的指标包括：

installs
clicks
impressions

您可以在我们的Datascape 指标术语表中查看完整指标列表。您还可以使用过滤器数据终端来搜索指标。

响应格式

{
   "rows": [
      {
         "attr_dependency": {},
         "app": "App Name",
         "partner_name": "AppLovin",
         "campaign": "Campaign Name (Campaign ID)",
         "campaign_id_network": "Campaign ID",
         "campaign_network": "Campaign Name",
         "installs": "64",
         "cost": "1000"
      }
   ],
   "totals": {
      "installs": 64,
      "cost": 1000
   },
   "warnings": [],
   "totals_per_dimension": {}
}

响应代码

终端返回以下响应：

响应	描述	注意事项
`200`	成功 (Success)	返回报告信息
`204`	无内容 (No content)	响应对象为空时
`400`	错误请求 (Bad request)	请求格式错误或包含不受支持的参数
`401`	未授权 (Unauthorized)	您的凭证不正确或缺失
`403`	禁止 (Forbidden)	您没有访问此信息的权限
`429`	请求过多 (Too many requests)	同时发送超过 50 个请求
`503`	服务不可用 (Service unavailable)	无法连接服务器
`504`	网关超时 (Gateway timeout)	查询返回响应时间过长

示例

$ curl \
--header 'Authorization: Bearer <adjust_api_token>' \
-L -X GET 'https://automate.adjust.com/reports-service/pivot_report?ad_spend_mode=network&app_token__in={app_token1},{app_token2}&date_period=2021-05-01:2021-05-02&dimensions=app,partner_name,campaign,campaign_id_network,campaign_network&metrics=installs,network_installs,network_cost,network_ecpi&index=app' \

{
   "rows": [
      {
         "Test App": {
            "rows": [
               {
                  "attr_dependency": {
                     "app_network": ["google_play:com.test.app"]
                  },
                  "campaign_id_network": "123",
                  "campaign_network": "Campaign Name",
                  "campaign": "Campaign Name (123)",
                  "partner_name": "MyPartner",
                  "installs": 10,
                  "network_installs": 0,
                  "network_cost": 0,
                  "network_ecpi": 0
               }
            ]
         }
      }
   ],
   "totals": {
      "installs": 10,
      "network_installs": 0,
      "network_cost": 0,
      "network_ecpi": 0
   },
   "totals_per_dimension": {
      "campaign_id_network": {
         "Organic": {
            "installs": 10,
            "network_installs": 0,
            "network_cost": 0,
            "network_ecpi": 0
         }
      },
      "campaign_network": {
         "Organic": {
            "installs": 10,
            "network_installs": 0,
            "network_cost": 0,
            "network_ecpi": 0
         }
      },
      "app": {
         "adjust Demo App": {
            "installs": 10,
            "network_installs": 0,
            "network_cost": 0,
            "network_ecpi": 0
         }
      },
      "campaign": {
         "Organic": {
            "installs": 10,
            "network_installs": 0,
            "network_cost": 0,
            "network_ecpi": 0
         }
      },
      "partner_name": {
         "Organic": {
            "installs": 10,
            "network_installs": 0,
            "network_cost": 0,
            "network_ecpi": 0
         }
      }
   }
}