群组报告API

Request header（请求头）

您可以使用下列参数筛选出您需要的数据。

您可以使用以下分组参数在报告中添加字段，帮助您更为宏观地了解数据。

• 下表列出了可用的KPI以及各KPI对应的函数，调用某个KPI时会返回其对应的所有函数。
• 拉取报告时默认包含的KPI为：users（用户）、ecpi（有效平均激活成本）以及cost（成本）。
• 每次调用仅限发送一个可选KPI。

KPI函数的表达

您可以使用下列KPI格式参数设置报告中的KPI格式。

本示例包含完整的API调用。

curl -L -X POST 'https://hq1.appsflyer.com/api/cohorts/v1/data/app/<insert your app_id here>?format=<insert results format here>' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <cohort_api_token_placeholder. Note the token has more than 700 characters.>' \
-H 'Accept: application/json' \
--data-raw '{
    "cohort_type": "user_acquisition",
    "min_cohort_size": 1,
    "preferred_timezone": false,
    "from": "2020-01-01",
    "to": "2020-01-31",
    "filters": {
        "period": [
            0,
            1,
            2,
            10,
            30,
            60
        ],
        "geo": [
            "US",
            "CN"
        ],
        "pid": [
            "Meta ads",
            "googleadwords_int"
        ]
    },
    "preferred_currency": true,
    "aggregation_type": "on_day",
    "per_user": false,    
    "groupings": [
        "pid",
        "date"
    ],
    "kpis": [
        "sessions"
    ]
}'

import http.client
import mimetypes
conn = http.client.HTTPSConnection("hq1.appsflyer.com")
payload = "{\r\n    \"cohort_type\": \"user_acquisition\",\r\n    \"min_cohort_size\": 1,\r\n    \"preferred_timezone\": false,\r\n    \"from\": \"2020-05-01\",\r\n    \"to\": \"2020-05-10\",\r\n    \"preferred_currency\": true,\r\n    \"aggregation_type\": \"cumulative\",\r\n    \"per_user\": false,   \r\n     \"groupings\": [\r\n               \"pid\",\r\n         \"date\"\r\n        ],\r\n    \"kpis\": [\r\n        \"roas\"\r\n    ]\r\n}"
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer [Enter token here]',
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}
conn.request("POST", "/api/cohorts/v1/data/app/[My App ID here]?format=csv", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
   

示例1：留存

在1月期间激活应用的用户在群组第7天、第14天和28天的分渠道留存（session）数据

{
  "per_user": false,
  "groupings": [
    "pid"
  ],
  "filters": {
    "period": [
      7, 14, 28
    ]
  },
  "partial_data": false,
  "aggregation_type": "on_day",
  "min_cohort_size": 1,
  "cohort_type": "user_acquisition",
  "from": "2021-01-01",
  "to": "2021-01-30",
  "kpis": [
    "sessions"
  ]
}

示例2：分广告系列的购买数据

激活后群组第3天的分广告系列收入数据

{  
  "per_user": false,
  "groupings": [
    "c"
  ],
  "filters": {
    "period": [
      3
    ],
    "c":[
        "example_campaign_name"
    ]
  },
  "partial_data": false,
  "aggregation_type": "cumulative",
  "min_cohort_size": 1,
  "cohort_type": "user_acquisition",
  "from": "2021-01-01",
  "to": "2021-01-30",
  "kpis": [
    "Checkout Start"
  ]
}

示例3：昨日用户行为
查看在指定转化时段内转化（激活、再互动、再归因）的用户在昨天完成了什么操作。

您可以通过Data Locker群组报告中的可用数据获取该信息。转化时段需限制在前360天之内。

返回的CSV文件名是基于API查询生成的，具体的文件名结构如下表所示。

CSV文件名示例

cohort_aggregation_type_per_user_kpi_report_app_id_from_to_timezone_currency_hash.csv

Period是指归因后的天数，period 0即为归因当天（归因日）。假设某用户在1月1日激活应用，1月1日则为归因日。在period 0发生的购买事件即为用户在1月1日完成的购买；在period 3发生的购买事件即为用户在1月4日完成的购买。同理，对于在1月11日激活的用户，1月11日即为period 0，其在1月14日完成的购买即为period 3的购买事件。

如果您的报告日期范围设置为1月1日至1月11日，则返回的数据仅限在这段时间内归因（激活）的用户，而不包含其他数据。

• period可以是0-180之间的一个或多个值，如0、1、2、30、180。
• 如果没有指定period，则报告会根据默认值0、1、2到30、60、90和180返回数据。

{
    "cohort_type": "user_acquisition",
    "min_cohort_size": 1,
    "preferred_timezone": false,
    "from": "2019-12-01",
    "to": "2020-01-01",
    "filters": {
        "period": [
            0,
            1,
            2
        ]
    },
    "aggregation_type": "on_day",
    "per_user": false,
    "groupings": [
        "pid"
    ],
    "kpis": [
        "revenue"
    ]
}

下图说明了群组分析面板与API参数之间的映射关系。API解决方案与面板相似，但仍有不同之处。

API方案提供以下附加选项：

• 货币选项
• 时区选项
• period（归因后天数）筛选条件

两种汇总类型之间的区别