Cost Data Query API

Overview

Query API는 프로그래밍 방식으로 사전 집계된 합산 데이터를 쿼리 하는 데 사용할 수 있는 HTTP API 입니다. 대시보드 자체에 접근하지 않고도 Branch 대시보드에 표시된 것과 동일한 데이터를 가져오는데 사용할 수 있습니다.

Please refer to the Query API for full reference documentation.

한계

Limitation

Details

OS (user_data_os) + Country (user_data_geo_country_code)

Querying with OS and Country dimensions will return an error.

Secondary Publisher (last_attributed_touch_data_tilde_secondary_publisher) + Country (user_data_geo_country_code)

Querying with Secondary Publisher and Country will return an error

비용 데이터

API를 통해 비용 데이터를 가져올 시 "파트너 및 캠페인별로 모든 비용 가져오기"를 활용하도록 권장합니다. 키워드 및 OS와 같은 것에 드릴 다운을 시도할 수 있지만 파트너 API가 제공하는 분석이 파트너마다 일관되지 않으므로 널(null)을 분명히 처리해야 할 것입니다. 대시보드가 특정 비용 분석에 대해 0을 반환하면 API도 마찬가지로 할 것입니다.

👍

유용한 팁

  • Aggregation must be cost or cost_in_local_currency (for other dimensions it could be "total_count" or "unique_count" but those are not applicable for cost).

  • If Aggregation is cost, then cost is returned in USD, where the exchange rate is stored at the time we retrieve from an API (virtually always the day of the campaign, e.g. we pull data for a campaign that ran Dec 17th 2020 into the Branch system on Dec 17th 2020 and the exchange rate will be the exchange rate on Dec 17th 2020). If Aggregation is cost_in_local_currency, then cost is returned in the currency associated with cost, when Branch pulled it from an ad network.

  • 광고 파트너 API에서 사용할 수 있는 파라미터만 반환하므로 종종 비용의 경우 dimension이 "null"로 표시됩니다. 예를 들어, Snap 데이터에는 사실상 디바이스 분석이 없습니다. (예: OS)

  • Supported partners: FB, Google, Snap, Apple, TikTok.

  • 비용 데이터는 일반적으로 파트너 API에서 사용 가능한 6-12시간 내에 Branch에서 사용할 수 있습니다.

  • 비용 데이터는 오늘 날짜로부터 최대 30일 전에 파트너 API에 대한 정확성 검사를 수행하고 비용을 새로 고치므로 시간이 지남에 따라 변경될 수 있습니다.

광고 파트너/캠페인당 비용

curl -X POST 'https://api.branch.io/v1/query/analytics' -H 'content-type: application/json' -d '{
  "start_date": "2019-12-06",
  "end_date": "2019-12-11",
  "branch_key": "<branch_live_key>",
  "branch_secret": "<secret_key>,
  "data_source": "cost",
  "enable_install_recalculation": true,
  "dimensions": [
    "last_attributed_touch_data_tilde_advertising_partner_name",
    "last_attributed_touch_data_tilde_campaign"
  ],                      
  "ordered": "descending",
  "aggregation": "cost"
}'

결과의 예:

{
  "results" : [ {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "fb_zeit",
      "cost" : 23636.767182316362,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Facebook"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "google_zeit",
      "cost" : 12475.522455796843,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Google AdWords"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName8",
      "cost" : 202.59,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName1",
      "cost" : 158.07999999999998,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName2",
      "cost" : 158.14,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName0",
      "cost" : 100.65,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName7",
      "cost" : 98.57,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName5",
      "cost" : 98.21000000000001,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName6",
      "cost" : 96.42,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName3",
      "cost" : 55.13,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  }, {
    "timestamp" : "2019-12-01T00:00:00.000-08:00",
    "result" : {
      "last_attributed_touch_data_tilde_campaign" : "CampaignName4",
      "cost" : 53.57,
      "last_attributed_touch_data_tilde_advertising_partner_name" : "Apple Search Ads"
    }
  } ],
  "paging" : {
    "total_count" : 11
  }
}