メインコンテンツへスキップ

​
概要

レポートAPIを使用すると、キャンペーン、商品、ユニット、クリエイティブ別の成果データおよびバックフィル広告収益データを照会できます。

​
事前準備

  • APIキーの発行が必要です（report:read権限）
  • 発行方法の詳細はOpen APIガイドをご参照ください

​
基本情報

項目値
Base URLhttps://lake.adrop.io
認証x-api-keyヘッダーにAPIキーを含める
Content-Typeapplication/json
最大照会期間30日

​
キャンペーンレポート

キャンペーン、商品、ユニット、クリエイティブ別の成果データをクロス集計で照会します。

​
リクエスト

POST /report

​
リクエストパラメータ

パラメータタイプ必須説明
tabstringO基本グルーピング次元（campaign、product、unit、creative）
segmentstringOクロス集計次元。tabとの有効な組み合わせを確認してください。
startDatestringO開始日（YYYY-MM-DD）
endDatestringO終了日（YYYY-MM-DD）。開始日から最大30日
rollupsstring[]-時間細分化オプション。dateは日別、timeは時間帯別データを追加
filtersobject[]-特定IDで結果をフィルタリング

​
tab × segment 有効な組み合わせ

tab使用可能なsegment
campaigncampaign、unit、creative
productcampaign、product、unit、creative
unitcampaign、product、unit、creative
creativeunit、creative

​
filtersの形式

{
  "filters": [
    {
      "field": "campaign",
      "value": ["CAMPAIGN_ID_1", "CAMPAIGN_ID_2"]
    }
  ]
}
fieldにはcampaign、product、unit、creativeのいずれかを指定し、valueに該当IDの配列を渡します。複数のフィルターを設定すると、すべての条件を満たすデータのみが返されます。

​
リクエスト例

curl -X POST https://lake.adrop.io/report \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tab": "campaign",
    "segment": "unit",
    "startDate": "2026-03-01",
    "endDate": "2026-03-07",
    "rollups": ["date"]
  }'

​
レスポンス

{
  "summary": {
    "impressions": 125000,
    "impressions_d": 100000,
    "impressions_v": 25000,
    "clicks": 3750,
    "clicks_d": 3000,
    "clicks_v": 750,
    "dismisses": 200,
    "ctr": 0.03,
    "ctr_d": 0.03,
    "ctr_v": 0.03
  },
  "items": [
    {
      "tab": "01J...",
      "segment": "01J...",
      "date_tz": "2026.03.01.",
      "id": "01J...",
      "title": "Campaign A",
      "campaign": "01J...",
      "campaign_name": "Campaign A",
      "campaign_status": "active",
      "unit": "01J...",
      "unit_name": "Banner Top",
      "impressions": 5000,
      "impressions_d": 4000,
      "impressions_v": 1000,
      "clicks": 150,
      "clicks_d": 120,
      "clicks_v": 30,
      "dismisses": 10,
      "ctr": 0.03,
      "ctr_d": 0.03,
      "ctr_v": 0.03
    }
  ]
}

​
レスポンスフィールド

summaryは全体合計、itemsは個別の詳細データです。

​
共通フィールド

フィールドタイプ説明
tabstring基本次元ID
segmentstringクロス次元ID（tab ≠ segmentの場合）
date_tzstring日付（rollupsにdateを含む場合）
hour_tzstring時間帯、例：“09-10”（rollupsにtimeを含む場合）
idstringエンティティID
titlestringエンティティ名

​
パフォーマンス指標

フィールドタイプ説明
impressionsnumber総インプレッション数（ディスプレイ + ビデオ）
impressions_dnumberディスプレイインプレッション数
impressions_vnumberビデオインプレッション数
clicksnumber総クリック数（ディスプレイ + ビデオ）
clicks_dnumberディスプレイクリック数
clicks_vnumberビデオクリック数
dismissesnumber閉じる数
ctrnumberクリック率（clicks / impressions）。0.027 = 2.7%
ctr_dnumberディスプレイCTR
ctr_vnumberビデオCTR

​
キャンペーン情報（tabまたはsegmentがcampaignの場合）

フィールドタイプ説明
campaignstringキャンペーンID
campaign_namestringキャンペーン名
campaign_statusstringキャンペーンステータス
start_timestringキャンペーン開始日
end_timestringキャンペーン終了日
target_impressionsnumber目標インプレッション数
target_clicksnumber目標クリック数
advertiser_namestring広告主名
agency_namestring代理店名
agency_emailstring代理店メール

​
商品/ユニット/クリエイティブ情報

フィールドタイプ説明
product / product_namestring商品ID / 名前
unit / unit_namestringユニットID / 名前
creative / creative_namestringクリエイティブID / 名前
creative_statusstringクリエイティブステータス

​
コスト/精算情報

フィールドタイプ説明
supply_amountnumber供給額（予算）
refund_amountnumber返金額
commissionnumber手数料
settlementnumber最終精算額（供給額 - 手数料 - 返金）
payment_typestring決済タイプ（card、bankなど）
pricing_typestring課金タイプ（CPM、CPC、CPPなど）
pricenumber単価
costnumber実際のコスト
currencystring通貨コード（USD、KRWなど）

​
バックフィルレポート

バックフィル広告収益データをユニット別、日別で照会します。すべての金額はUSD基準です。

​
リクエスト

POST /report/backfill

​
リクエストパラメータ

パラメータタイプ必須説明
startDatestringO開始日（YYYY-MM-DD）
endDatestringO終了日（YYYY-MM-DD）。開始日から最大30日

​
リクエスト例

curl -X POST https://lake.adrop.io/report/backfill \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": "2026-03-01",
    "endDate": "2026-03-07"
  }'

​
レスポンス

{
  "summary": {
    "impressions": 50000,
    "clicks": 1500,
    "ctr": 0.03,
    "cpc": 0.12,
    "cpm": 2.5,
    "revenue": 125.0,
    "showRate": 0.85
  },
  "items": [
    {
      "unit": "01J...",
      "unit_name": "Banner Top",
      "date": "2026-03-01",
      "impressions": 8000,
      "showRate": 0.85,
      "clicks": 240,
      "ctr": 0.03,
      "cpc": 0.12,
      "cpm": 2.5,
      "revenue": 20.0
    }
  ]
}

​
レスポンスフィールド

フィールドタイプ説明
unitstringユニットID
unit_namestringユニット名
datestring日付（YYYY-MM-DD）
impressionsnumberインプレッション数
showRatenumber表示率（インプレッション / フィル）。0.85 = 85%
clicksnumberクリック数
ctrnumberクリック率。0.027 = 2.7%
cpcnumberクリック単価（USD）
cpmnumber千回インプレッション単価（USD）
revenuenumber収益（USD）

​
エラーコード

HTTPステータス説明
400不正なリクエスト。日付範囲超過（30日）、無効なtab × segment組み合わせなど
401APIキーがないか無効
403report:read権限がない
502内部サービスエラー。しばらくしてから再試行してください

​
制限事項

  • 1回のリクエストで照会できる最大期間は30日です。
  • 日付形式はYYYY-MM-DD（ISO 8601）のみサポートします。
  • APIキーごとのリクエスト制限は現在適用されていませんが、今後変更される可能性があります。