# APIからレポートを取得する

# レポート取得方法

レポートAPIを使用すると、指定したメトリクスとディメンションについてのレポートをダウンロードできます。
出力するレポートのフォーマットはCSVもしくはJSONが選択できます。

注意

レポートAPIで取得できる推定収益額, 推定eCPM, 推定CPCなどは全て税抜価格で表示されます。インプレッションやクリックなどのイベントの発生件数が1件以下の場合は、関連するメトリクスが非表示になるか、0で表示されます。レポート画面で表示される値とは異なる可能性があります。

# コマンド例

レポートをダウンロードするコマンドの例です。 リクエストURLやリクエストボディの詳細についてはレポートAPIの仕様セクションをご参照ください。

curl -u ${API_KEY_ID}:${API_KEY_SECRET} \
    -X POST \
    -H "Content-Type: application/json" \
    -d "${リクエストボディ}" \
    ${リクエストURL}

リクエストボディの例。

{
  "start_date": "2024-01-01",
  "end_date": "2024-01-01",
  "dimensions": [
    "date",
    "app_id",
    "slot_id"
  ],
  "metrics": [
    "imp",
    "click"
  ],
  "filter": {
    "app_ids": [
      12345
    ]
  },
  "from": 0,
  "limit": 1000
}

結果は直接レスポンスで返されます。CSVフォーマットのレスポンスは次のようになります。

date,app_id,slot_id,imp,click
2024-01-01,12345,6789,5432,5
2024-01-01,12345,6790,3310,2

# レポートAPIの仕様

# リクエストURL

# CSVフォーマット用 URL

https://adsnetwork.line.biz/api/public/v1/reports.csv

# JSONフォーマット用 URL

https://adsnetwork.line.biz/api/public/v1/reports.json

# リクエストボディ

リクエストボディには、以下のフィールドを指定します。

フィールド	定義	タイプ	必須	デフォルト値	備考
start_date	開始日、YYYY-MM-DD 形式	string	YES		2年前の日付まで指定可能
end_date	終了日、YYYY-MM-DD 形式	string	YES		開始日と終了日の差が90日分まで指定可能
dimensions	ディメンションセクションを参照	Array[string]	YES
metrics	メトリクスセクションを参照	Array[string]	YES
filter	フィルターセクションを参照	object	NO
from	取得開始位置	int	NO	0
limit	取得件数	int	NO	1000	取得件数の上限は1000

# レスポンスコード

APIによって返される可能性のあるレスポンスコードは以下の通りです。

400: リクエストが不正、または構文や検証エラー。リクエストが有効な形式であることを確認してください。
401: 認証失敗。認証ヘッダーが適切にフォーマットされていることを確認してください。
429: リクエスト数の超過。少し待ってから再度実行してください。
500: 不明なエラー。

# ディメンション

ディメンションを指定することで、集計レベルを指定できます。
ディメンションの数や順序に制限はありません。

フィールド	説明	例
date	日時	`2024-01-01`
app_id	アプリID	`12345`
app_name	アプリ名	`テストアプリ`
slot_id	スロットID	`6789`
slot_name	スロット名	`テストスロット`
device_type	デバイス種別	`IOS` / `ANDROID`

# メトリクス

指定したメリトリクスがレポートの各行の要素に含まれます。
メトリクスの数や順序に制限はありません。

フィールド	説明	例
imp	広告表示回数	`183`
click	クリック数	`14`
ctr	クリック率	`0.1138`
ecpm	推定eCPM(税抜)	`8.47`
cpc	推定CPC(税抜)	`50.12`
revenue	推定収益額(税抜)	`365.18`

# フィルター

フィルターを指定することで、レスポンスに含まれるデータを絞り込み、より具体的なレポートを作成できます。

フィールド	説明	タイプ	必須	備考
app_ids	アプリIDリスト	Array[int]	NO
slot_ids	スロットIDリスト	Array[string]	NO

← LAN Dashboard APIの利用・停止方法 APIの使用履歴を取得する →