リクエストヘッダー

次のフィルターパラメーターを使用して、必要なデータを取得します。 

次のグループ化パラメーターを使用して、追加の列を含め、レポートの粒度を下げます。

• この表では、利用できるKPIのリストとそれに関する関数を示しています。KPIを呼び出すとそのすべての関数が返されます。
• 次のKPIは常に返されます：users、ecpi、cost 
• コールごとに追加KPIを1つ選択します。

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": [
            "Facebook 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日目のメディアソースのリテンション（セッション）

{
  "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

期間はアトリビューション後の日を指し、期間0はアトリビューション日です。例えば、ユーザーがアプリを1月1日にインストールします。これがアトリビューション日です。期間0に購入が発生した場合、この購入は1月1日に発生しました。期間3に購入が発生した場合、この購入は1月4日に発生しました。同様に、11月11日にインストールしたユーザーは、これが期間0になります。1月14日に発生した購入は期間3となります。

レポートの期間範囲が1月1日から1月11日の場合、この期間にアトリビュート（インストール）されたユーザーがレポートに含まれます。その他のデータは含まれません。

• 期間の値は、0-180のうち1つまたは複数設定できます。例：0, 1, 2, 30, 180。 
• 期間が指定されていない場合、デフォルト値である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とユーザーインターフェイスの2つのソリューションは、似ていますが同一ではありません。

このAPIバージョンには、次の追加オプションがあります。

• 通貨の選択
• タイムゾーンの選択
• 期間で絞り込み

集計タイプの違い