/api/v1

Overview

このドキュメントはSCENE APIを利用する方向けのドキュメントです。

Access Token

保護されたリソースにアクセスする場合に利用します。
アクセストークンはユーザー設定画面上に表示されています。

General Errors

Status code Response body Reason
400 {"error":"invalid_request"} アクセストークンが無効です。正しいアクセストークンを指定てしください。
401 {"error":"invalid_token"} 保護されたリソースにアクセスしようとしましたが、アクセストークンがセットされていません。

Timestamp

タイムスタンプを表現する場合はISO 8601のフォーマットを適用してください。
例:2016-01-23T12:34:50

Authorization

アクセストークンに関するAPIです。

GET

curl -u {EMAIL} https://scene.lokaplatform.com/api/v1/auth

Response JSON

Property Type Description
access_token String アクセストークンです。

PATCH

アクセストークンを更新します。
第三者に漏えいしたなどの理由がない限り、アクセストークンを更新する必要はありません。

curl -X PATCH -u {EMAIL} https://scene.lokaplatform.com/api/v1/auth

Response JSON

Property Type Description
status String アクセストークンの状態です。
access_token String 更新後のアクセストークンです。

Reports

レポートを取得します。正しくリクエストしている場合、レスポンスはCSVとなります。

curl -H "Authorization: Bearer {ACCESS_TOKEN}" "https://scene.lokaplatform.com/api/v1/reports"

Query parameters

Key Type Description Default
start_at
end_at
String レポートの集計期間です。ISO 8601形式で記載してください。 先月の一日から末日
interval String レポートを集計する期間です。hour, day, month(毎時、日次、月次)を選択できます。 day
campaign
unit
delivery
material
String IDかユニークIDを指定すると、集計を絞り込むことができます。 -
axis_type String 集計する関連軸を指定します。関連軸については後述するAxisを参照してください。 -

Axis

Axis type Description
campaign キャンペーンごとに集計します。
unit クリエイティブごとに集計します。
delivery 配信設定ごとに集計します。
material 素材ごとに集計します。
region 地域ごとに集計します。
device デバイスごとに集計します。
os オペレーションシステムごとに集計します。
browser ブラウザごとに集計します。
current_url 掲載元URLごとに集計します。
referer_url 参照元URLごとに集計します。

current_urlreferer_urlはユーザーの権限によって参照できない場合があります。

Example

このAPIの使用例を示します。これらは一例であり、権限によって結果が取得できないことがあります。

  1. 2016-12-01から2016-12-31まで、キャンペーン44の日別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&campaign=44"
  2. 2016-12-01から2016-12-31まで、ユニット424の日別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&unit=424"
  3. 2016-12-01から2016-12-31まで、配信ID OHg2u_3dTenl6CYe の日別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&delivery=OHg2u_3dTenl6CYe"
  4. 2016-12-01から2016-12-31まで、素材ID TEAcYYrI1nCxZO4M の日別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&material=TEAcYYrI1nCxZO4M"
  5. 2016-12-01から2016-12-31まで、キャンペーン44 の素材別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&campaign=44&axis_type=material"
  6. 2016-12-01から2016-12-31まで、素材ID TEAcYYrI1nCxZO4M のブラウザ別レポートを取得します。

    curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&material=TEAcYYrI1nCxZO4M&axis_type=browser"