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

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

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

事前準備

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

エンドポイント

1
GET https://automate.adjust.com/reports-service/filters_data

GETリクエスト

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

パラメーター

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

必須のフィルター

フィルター (Filter)	説明
`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`	広告収益ソースのリストを返します。
`iap_revenue_mode`	広告収益モードのリストを返します。
`attribution_type`	アトリビューションタイプのリストを返します。例：all、click、impression。
`attribution_source`	アトリビューションソースのリストを返します。
`attribution_status`	アトリビューションのステータスのリストを返します。
`ad_spend_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`	クエリが応答を返すのに時間がかかりすぎた場合に返される

成功レスポンス

1
{
2
   "required_filters_1": [
3
      {
4
         "id": "string",
5
         "name": "string",
6
         "short_name": "string",
7
         "section": "string",
8
         "formatting": "string"
9
      }
10
   ],
11
   "required_filters_2": [
12
      {
13
         "id": "string",
14
         "name": "string",
15
         "short_name": "string",
16
         "section": "string",
17
         "formatting": "string"
18
      },
19
      {
20
         "id": "string",
21
         "name": "string",
22
         "short_name": "string",
23
         "section": "string",
24
         "formatting": "string"
25
      }
26
   ]
27
}

パラメーター

パラメーター	データタイプ	説明
`id`	`String`	フィルター項目のID。これを使用して、APIコールをフィルターします。
`name`	`String`	フィルター項目の読み取り可能な名前。
`short_name`	`String`	フィルター項目の短縮された名前。
`section`	`String`	フィルター項目が関連付けられているセクション。
`formatting`	`String`	フィルター項目のデータ形式。例：`money`、`decimal`、`string`。

例

curl --location --request GET 'https://automate.adjust.com/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"
      }
   ]
}