フィルターデータのエンドポイント

フィルターデータのエンドポイントにより、有効な指標のリストを取得できます。これらの指標を使用して、レポートサービスAPIスイートでその他のエンドポイントへのコールをフィルターすることができます。

指標の全リストはDatascape 指標用語集をご覧ください。

事前準備

このエンドポイントを使用するには、Adjust APIトークンが必要です。トークンを取得するには、認証ガイドの手順に従ってください。

エンドポイント

https://dash.adjust.com/control-center/reports-service/filters_data

GETリクエスト

フィルター項目のリストを返します。その他のAPIコールをフィルターするには、返されたオブジェクトのidフィールドを使用してください。

パラメーター

パラメーター	データタイプ	in	説明
`required_filters`*	文字列	クエリ	フィルターのコンマ区切りリスト。値のリストについては、下の「必須のフィルター」の表を参照してください。
`section`	列挙<文字列>	クエリ	項目をフィルターするセクション。値のリストについては、下の「セクション」の表を参照してください。
`[required_filters]__contains`	文字列	クエリ	検索語を入力して、オブジェクトの `id` と`name`フィールドで完全一致または部分一致を検索します。

必須のフィルター

フィルター	説明
`apps`	アプリのリストを返します。
`apps_network`	アプリとそれらに関連するストアIDのリストを返します。
`overview_metrics`	概要の指標のリストを返します。
`skad_metrics`	SKAdNetworkに関連する指標のリストを返します。
`cohort_maturity`	コホートの成熟度に関連する指標のリストを返します。例： `mature`、`immature`。
`cohort_metrics`	コホートに関連する指標のリストを返します。
`event_metrics`	イベントに関連する指標のリストを返します。イベントごとにすべての指標が複製されます。
`cost_metrics`	コストに関連する指標のリストを返します。
`etl_metrics`	Adjustともう1つのシステムの間でのETL（抽出、変換、読み込み）に関連する指標のリストを返します。
`dimensions`	ディメンションのリストを返します。
`countries`	国のリストを返します。
`currencies`	通貨のリストを返します。
`os_names`	オペレーティングシステム名のリストを返します。
`networks`	ネットワークのリストを返します。
`partners`	パートナーのリストを返します。
`ad_revenue_sources`	広告収益ソースのリストを返します。
`ad_revenue_mode`	広告収益モードのリストを返します。
`attribution_type`	アトリビューションタイプのリストを返します。例： `all`、`click`、`impression`。
`attribution_source`	アトリビューションソースのリストを返します。
`attribution_status`	アトリビューションのステータスのリストを返します。
`cost_mode`	コストモードのリストを返します。例： `attribution`、`network`、`mixed`。
`ad_spend_mode`	広告費用モードのリストを返します。例： `attribution`、`network`、`mixed`。
`utc_offset`	UTC（協定世界時）との差。デフォルトは `0` （UTC)。
`attributes`	アトリビュートのリストを返します。
`index`	すべてのアプリに関連する主要な指標のリストを返します。
`period_over_period`	データの比較に使用される期間のリストを返します。
`cohort_metric_names`	コホート指標の読み取り可能な名前のリストを返します。
`full_cohort_periods`	コホートに関連する期間のリストを返します。
`store_type`	App Storeのリストを返します。
`skad_time_adjustment`	有効なSKAdNetworkアクティビティウィンドウのリストを返します。

セクション

セクション	説明
`conversion`	クリックおよびインプレッションコンバージョンに関する指標。
`fraud`	不正防止に関する指標。
`cost`	コストに関する指標。
`revenue`	アプリ収益に関する指標。
`retention`	コホートベースのユーザー継続率に関する指標。
`events`	イベントに関する指標。
`conversion_events`	SKAdNetworkコンバージョンイベントに関する指標。
`installs`	アプリのインストールと再インストールに関する指標。
`conversion_values`	SKAdNetwork conversion valueに関する指標。

レスポンス

このエンドポイントは、以下のレスポンスを返します：

レスポンス	説明	注意
200	成功 (Success)	レポート情報を返す
204	内容なし（No content）	レスポンスオブジェクトが空の場合に返される
400	不正なリクエスト（Bad request）	リクエストに不正があるか、サポートされていないパラメーターが含まれている場合に返される
401	無許可（Unauthorized）	認証情報が正しくないか欠けている場合に返される
403	禁止（Forbidden）	閲覧許可がない情報にアクセスしようとした場合に返される
429	リクエスト過多（Too many requests）	同時リクエストが50回を超えた場合に返される
503	サービス利用不可（Service unavailable）	サーバーにリーチできなかった場合に返される
504	ゲートウェイタイムアウト（Gateway timeout）	クエリが応答を返すのに時間がかかりすぎた場合に返される

成功レスポンス

{
   "required_filters_1": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      }
   ],
   "required_filters_2": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      },
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      }
   ]
}

パラメーター

パラメーター			データタイプ	説明
`required_filters`			配列<オブジェクト>	返されたフィルターオブジェクトが含まれている配列。コールに追加した `required_filter` ごとに1つの配列が返されます。
	戻り値		オブジェクト	返されるフィルター項目。
		`id`	文字列	フィルター項目のID。これを使用して、APIコールをフィルターします。
		`name`	文字列	フィルター項目の読み取り可能な名前。
		`short_name`	文字列	フィルター項目の短縮された名前。
		`section`	文字列	フィルター項目が関連付けられているセクション。
		`formatting`	文字列	フィルター項目のデータ形式。例： `money`、`decimal`、`string`。

例

cURL

curl --location --request GET 'https://dash.adjust.com/control-center/reports-service/filters_data?required_filters=overview_metrics,cost_metrics&section=cost&overview_metrics__contains=ecpi&cost_metrics__contains=Ad spend' \
--header 'Authorization: Bearer {API_TOKEN}'

{
    "overview_metrics": [
        {
            "id": "ecpi_all",
            "name": "eCPI (All Installs)",
            "short_name": "eCPI (All)",
            "section": "Cost",
            "formatting": "money"
        },
        {
            "id": "ecpi",
            "name": "eCPI (Paid Installs)",
            "short_name": "eCPI (Paid)",
            "section": "Cost",
            "formatting": "money"
        }
    ],
    "cost_metrics": [
        {
            "id": "network_cost",
            "name": "Ad Spend (Network)",
            "short_name": "",
            "section": "Cost",
            "formatting": "decimal"
        },
        {
            "id": "network_cost_diff",
            "name": "Ad Spend Diff (Network)",
            "short_name": "",
            "section": "Cost",
            "formatting": "decimal"
        }
    ]
}