メインコンテンツまでスキップ

Reporting API

注記

非推奨通知非推奨通知 への直接リンク

以下に記載されているRokt Reporting APIは非推奨となり、新しい更新や機能強化は行われません。すべてのクライアントに対して、より柔軟性があり、パフォーマンスが向上し、レポート用途におけるメトリクス/ディメンションのサポートが拡大されたRokt Query APIへの移行を強く推奨します。

なぜ変更するのか？なぜ変更するのか？ への直接リンク

Query APIは、キャンペーンおよびトランザクションデータを取得するための最新化され統一されたインターフェースを提供し、以下を可能にします：

  • 複数のディメンションによる動的なグルーピング
  • 簡素化され一貫性のあるリクエスト構造
  • 強化されたフィルタリング機能
  • 将来のレポートメトリクスおよびディメンションのスケーラブルなサポート

移行サポート移行サポート への直接リンク

移行を支援するために、各レガシーレポートエンドポイントを対応するQuery APIリクエストボディにマッピングしたQuery API移行ガイドを参照してください。このガイドには以下が含まれます：

  • 現在のAPI呼び出しを置き換えるための1対1の例
  • パラメータ変換に関する指示（例：アカウントID、タイムゾーン、通貨）
  • 現在サポートされていないメタデータエンドポイントに関する情報

⚠️ 注意: 一部のレガシーメタデータエンドポイント（キャンペーン、オーディエンス、クリエイティブメタデータ）は、まだQuery APIでサポートされていません。別途通知があるまで、これらのレガシーエンドポイントを使用し続けてください。

概要概要 への直接リンク

Rokt Reporting APIは、広告主やパートナーがRoktプラットフォームからパフォーマンスデータを取得し、自分たちのレポートやダッシュボードを構築することを可能にします。これはHTTPベースのAPIであり、Roktデータを外部のビジネスアプリケーションにプログラム的にクエリし統合するために使用できます。このAPIは、HTTPリクエストを行うことをサポートする任意の言語で動作します。ほとんどすべてのリクエストはhttps://api.rokt.comホストURLに送信されます。

データを安全に保つために、Rokt Reporting APIはアクセストークンを使用してリクエストを認証します。アクセストークンは、Roktがクライアントアプリケーションとアクセスされるデータの種類を識別し、不正なアプリが見てはいけないデータにアクセスするのを防ぎます。

APIへの認証はOAuth 2.0を通じて行われます。API呼び出しを成功させるには、App IDとApp Secretを使用してアクセストークンを取得する必要があります。認証なしのAPIリクエストは失敗します。Rokt Reporting APIは、ユーザー資格情報がアクセスできるアカウントからのみデータを取得することを許可します。

バージョンバージョン への直接リンク

APIのアルファリリースバージョンを使用する早期導入者は、APIリクエストヘッダーで"rokt-version":"alpha-20200701"を使用して、可能な限りの破壊的変更を最小限に抑えてください。rokt-versionヘッダーが使用されていない場合、エンドポイントリクエストは常にRokt Reporting APIのLATESTバージョンを指します。

認証認証 への直接リンク

Rokt Reporting APIは、クライアント統合にOAuth 2.0アプローチを活用しています。詳細については、OAuth 2.0 Credentials Flowを参照してください。Rokt Reporting APIにアクセスするには、Rokt App IDとApp Secretを使用する必要があります。

これらのクライアントアプリケーションの資格情報をRokt Reporting APIとのRESTインタラクションで使用する必要があります。

App IDとApp Secretの生成App IDとApp Secretの生成 への直接リンク

  1. my.rokt.comでOne Platformにサインインします。

  2. 左下のアカウントアイコンの下にあるプロフィール設定に移動します。

    img

  3. 個人用API資格情報の生成セクションまでスクロールします。

  4. アプリの名前を入力します。

  5. 生成をクリックします。

  6. Reporting APIとEvent APIの両方の資格情報がすぐに生成され、次のようになります：

    AppId: "40svbin0d194subpohl079rhck"
    AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"

  7. App IDとApp Secretを安全な場所に保管してください。このセッションの後にApp Secretにアクセスすることはできません。

  8. これらの資格情報はすぐに使用できます。

資格情報は機密情報として扱い、アカウントを保護するためにメールで送信しないでください。Roktからの問い合わせであっても、組織外に共有しないでください。Roktを正当に代表する者がApp Secretを尋ねることは決してありません。

アクセストークンの取得アクセストークンの取得 への直接リンク

Rokt Reporting APIのエンドポイントを呼び出すにはアクセストークンが必要です。アクセストークンは、Roktがクライアントアプリを識別し、各クライアントアプリがアクセスするデータの種類を特定し、悪意のあるアプリがアクセス権のないデータにアクセスするのを防ぎます。

APIへの認証はOAuth 2.0を介して行われます。成功したAPI呼び出しを実行するには、App IDとApp Secretを使用してアクセストークンを取得し、すべてのAPI呼び出しで使用する必要があります。App IDとApp Secretは、上記のようにOne Platformのプロフィール設定ページで生成できます。

認証なしまたは不正な認証でのAPIリクエストは失敗します。APIは400または403のエラーコードを返します。Rokt Reporting APIからは、ユーザー資格情報がアクセスできるアカウントのデータのみを取得できます。

アクセストークンは、前のステップで作成されたApp IDとApp Secretに基づいて生成されます。アクセストークンは1時間有効です。その間、アクセストークンを使用してRokt Reporting APIのすべてのエンドポイントを呼び出すことができます。有効期限が切れる前に、クライアントアプリの資格情報に基づいてアクセストークンを再生成する必要があります。

アクセストークンを取得するために、Rokt Reporting APIにエンドポイントが公開されています：

POST https://api.rokt.com/auth/oauth2/token

ヘッダー内のリクエストパラメータヘッダー内のリクエストパラメータ への直接リンク

キー場所説明必須?例
Authorizationheaderapp_idとapp_secretは、Basic HTTP認証を通じて認証ヘッダーに渡され、One PlatformのProfile Settingsで生成できます。ヘッダーの内容はBasic base64encode(app_id:app_secret)です。はいBasic base64encocde(12345:abcde)
Content-Typeheaderリクエストのメディアタイプは常にapplication/x-www-form-urlencodedでなければなりません。はいapplication/x-www-form-urlencoded

ボディ内のリクエストパラメータボディ内のリクエストパラメータ への直接リンク

キー場所説明必須?例
grant_typebodyclient_credentialsでなければなりません。はいclient_credentials

成功したリクエストの例成功したリクエストの例 への直接リンク

サンプルリクエスト:

curl -vX POST  https://api.rokt.com/auth/oauth2/token \
	-H 'Authorization: Basic ${AuthToken}' \
	-H 'Content-Type: application/x-www-form-urlencoded' \
	-d 'grant_type=client_credentials'

サンプルレスポンス:

{
    "access_token": "eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA",
    "expires_in": 3600,
    "token_type": "Bearer"
}

API エンドポイントAPI エンドポイント への直接リンク

API エンドポイントの呼び出しAPI エンドポイントの呼び出し への直接リンク

前のステップで取得したアクセストークンを使用して、Rokt Reporting APIのエンドポイントを呼び出すことができます。トークンはBearerトークンとしてAuthorizationヘッダーに送信されなければなりません。

サンプルAPIリクエスト:

GET https://api.rokt.com/reporting/performance-reports/partner/1/stats?dateStart=2020-02-05&dateEnd=2020-02-12&
Authorization=Bearer "eyJraWQiOiJNMDJyQmZzT3pNKzRVMjhHRjVuaDdIREphWlIwaytDMlwvNFl5dXYxZ2N0ST0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0MHN2YmluMGQxOTRzdWJwb2hsMDc5cmhjayIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoicmVwb3J0LWFwaVwvcmVhZC1yZXBvcnQtYXBpIiwiYXV0aF90aW1lIjoxNTg1MTEwMDQxLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtd2VzdC0yLmFtYXpvbmF3cy5jb21cL3VzLXdlc3QtMl9kb3dOWnV6VFgiLCJleHAiOjE1ODUxMTM2NDEsImlhdCI6MTU4NTExMDA0MSwidmVyc2lvbiI6MiwianRpIjoiZDFlNjgyMDYtNWVlNy00NThjLTkwODYtZjAwYjhiMjEzYjJhIiwiY2xpZW50X2lkIjoiNDBzdmJpbjBkMTk0c3VicG9obDA3OXJoY2sifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA"

アカウントキャンペーンの内訳を取得アカウントキャンペーンの内訳を取得 への直接リンク

注記

⚠️ 廃止のお知らせ

このAPIは廃止され、今後更新されません。Query APIを使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、および通貨に対するRokt Ads広告主アカウントの総活動のパフォーマンス指標を返します。デフォルトでは、結果はキャンペーンごとに分解されますが、国ごとに活動を分解することもできます。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するcamapignidごとに分解されたアカウントレベルのデータを受け取ります。「groupby」パラメータを通じて呼び出すことができる属性には以下が含まれます:

  • country

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/breakdown
パラメータパラメータ への直接リンク
名前タイプ場所説明必須例
dateStartStringqueryリクエストされた日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryオルソン形式での希望するタイムゾーンtruetimeZoneVariation=Australia/Sydney
accountIdStringpathあなたのRoktアカウントID。One Platformで見つけるか、アカウントマネージャーから提供されます。 true 

ResponseResponse への直接リンク

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "referrals": 0,
 "campaignCountries": 0,
 "campaigns": 0,
 "acquisitionsByConversionDate": 0,
 "acquisitionsByReferralDate": 0,
 "creatives": 0,
 "Audiences": 0,
 "campaignName": "string"
}

GET Account SummaryGET Account Summary への直接リンク

注記

⚠️ 非推奨のお知らせ

このAPIは非推奨となり、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、および通貨に対するアカウントの総活動のパフォーマンス指標を返します。このAPIエンドポイントは、Rokt EcommerceパートナーアカウントデータとRokt Ads広告主アカウントデータの両方に使用できます。

説明説明 への直接リンク

指定された期間、タイムゾーン、および通貨に対するアカウントレベルのパフォーマンス指標を受け取るために、このAPIエンドポイントを呼び出します。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/summary
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStartStringquery要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringquery要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
  "campaignsSummary": {
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
  },
  "transactionsSummary": {
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "rpt": 0,
  "rpm": 0,
  "positivePlacementEngagements": 0,
  "purchases": 0
  }
}

GET Account Transactions OverviewGET Account Transactions Overview への直接リンク

注記

⚠️ 廃止予定のお知らせ

このAPIは廃止され、今後更新されません。Query APIを使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、および通貨にわたるRokt Ecommerceパートナーアカウントのパフォーマンス指標を返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するアカウントレベルのトランザクション指標（配置インプレッション、紹介、収益など）を受け取ります。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/transactions/overview

パラメータ

名前タイプ場所説明必須例
dateStartStringqueryリクエストされた日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "rpt": 0,
  "rpm": 0,
  "positivePlacementEngagements": 0,
  "purchases": 0
}

GET Account Transactions BreakdownGET Account Transactions Breakdown への直接リンク

注記

⚠️ 廃止のお知らせ

このAPIは廃止され、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、および通貨に対して、Rokt Ecommerceパートナーアカウントのパフォーマンス指標を属性ごとに分解して返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対して、クエリ文字列で指定された属性ごとに分解されたアカウントレベルのトランザクション指標を受け取ります。"groupby"パラメータを通じて呼び出すことができる属性には以下が含まれます：

  • 年齢
  • 性別
  • ページ
  • ページタイプ
  • 配置
  • 位置
注記

配置の内訳は、トランザクション、購入、またはRPTを含むページレベルの指標の結果を返しません。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/transactions/breakdown
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStart文字列クエリリクエストされた日付/時間範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリリクエストされた日付/時間範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス true 

ResponseResponse への直接リンク

200 OK

{
  "groupByValue": "string",
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "purchases": 0,
  "positivePlacementEngagements": 0,
  "rpt": 0,
  "rpm": 0
}

GET Audience MetadataGET Audience Metadata への直接リンク

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、オーディエンス名、年齢範囲、性別、デバイスなどのオーディエンスメタデータを受け取ります。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
パラメータパラメータ への直接リンク
名前型入力場所必須
accountIdStringpathtrue
campaignIdStringpathtrue
audienceIdStringpathtrue

レスポンスレスポンス への直接リンク

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "audienceId": "string",
  "name": "string",
  "ageRange": {
    "min": 0,
    "max": 0
  },
  "device": {
    "desktop": true,
    "tablet": true,
    "mobile": true
  },
  "gender": "string"
}

GET Campaign OverviewGET Campaign Overview への直接リンク

注記

⚠️ 非推奨通知

このAPIは非推奨となり、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、および通貨に対するキャンペーンのパフォーマンス指標を返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するインプレッション、リファラル、コンバージョンなどのキャンペーンレベルのパフォーマンス指標を受け取ります。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
パラメータパラメータ への直接リンク
名前型入力場所説明必須例
dateStartStringquery要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringquery要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		query希望するタイムゾーンはこのパラメータを通じて渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
}

GET Campaign BreakdownGET Campaign Breakdown への直接リンク

注記

⚠️ 非推奨通知

このAPIは非推奨となり、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については移行ガイドを参照してください。

指定された期間、タイムゾーン、または通貨に対して、国、キャンペーン、オーディエンス、またはクリエイティブごとに分解されたキャンペーンのパフォーマンス指標を返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、または通貨に対してクエリ文字列で指定された属性ごとに分解されたキャンペーンレベルのデータを受け取ります。"groupby"パラメータを通じて呼び出すことができる属性には以下が含まれます：

  • 国;
  • キャンペーン;
  • オーディエンス;
  • クリエイティブ; または
  • サブバーティカル。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStartStringquery要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringquery要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "referrals": 0,
 "acquisitionsByConversionDate": 0,
 "acquisitionsByReferralDate": 0,
 "campaigns": 0,
 "creatives": 0,
 "audiences": 0,
 "campaignCountries": 0,
 "creativeName": "string"
}

GET Campaign HistogramGET Campaign Histogram への直接リンク

注記

⚠️ 廃止予定のお知らせ

このAPIは廃止予定であり、今後更新されません。Query APIを使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、通貨に基づいて、キャンペーンのパフォーマンス指標を期間ごとに分解して返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨に対するキャンペーンのパフォーマンス指標（インプレッション、リファラル、コンバージョンなど）のヒストグラムを受け取ります。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStartStringquery要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringquery要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryこのパラメータを通じて希望のタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
  },
 {
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
 }

GET Campaign MetadataGET Campaign Metadata への直接リンク

説明説明 への直接リンク

特定のキャンペーンのメタデータを受け取るためにこのAPIエンドポイントを呼び出します。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
パラメータパラメータ への直接リンク
名前型場所必須
accountIdStringpathtrue
campaignIdStringpathtrue

レスポンスレスポンス への直接リンク

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "campaignName": "string",
  "campaignType": "string",
  "campaignObjective": "string",
  "countryCode": "string",
  "status": "string"
}

GET Creative OverviewGET Creative Overview への直接リンク

注記

⚠️ 非推奨通知

このAPIは非推奨であり、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については、移行ガイドを参照してください。

指定された期間、タイムゾーン、通貨に対するクリエイティブのパフォーマンス指標を返します。

説明説明 への直接リンク

指定された期間、タイムゾーン、通貨に対するインプレッション、リファラル、コンバージョンなどのクリエイティブレベルのパフォーマンス指標を取得するためにこのAPIエンドポイントを呼び出します。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStartStringquery要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringquery要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 
creativeIdStringpath true 

ResponseResponse への直接リンク

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "uniqueReferrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

GET Creative BreakdownGET Creative Breakdown への直接リンク

注記

⚠️ 非推奨通知

このAPIは非推奨となり、今後更新されません。Query APIを代わりに使用してください。

同等のリクエスト例については移行ガイドを参照してください。

指定された期間、タイムゾーン、通貨に対して、属性別に分解されたクリエイティブのパフォーマンス指標を返します。

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨に対して、クエリ文字列で指定された属性別に分解された特定のクリエイティブの詳細を取得します。"groupby"パラメータを通じて呼び出すことができる属性は以下の通りです：

  • オーディエンス;

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
パラメータパラメータ への直接リンク
名前型場所説明必須例
dateStart文字列クエリ要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙型:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙型:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリこのパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス true 
campaignId文字列パス true 
creativeId文字列パス true 

ResponseResponse への直接リンク

200 OK

{
  "groupByValue": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueReferrals": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

GET Creative MetadataGET Creative Metadata への直接リンク

説明説明 への直接リンク

このAPIエンドポイントを呼び出して、クリエイティブ名、タイトル、サブタイトル、テキスト、レスポンス、ステータスを含むクリエイティブメタデータを受け取ります。

リクエストリクエスト への直接リンク

パスパス への直接リンク
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
パラメータパラメータ への直接リンク
名前型場所必須
accountIdStringpathtrue
campaignIdStringpathtrue
creativeIdStringpathtrue

レスポンスレスポンス への直接リンク

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "creativeId": "string",
  "name": "string",
  "title": "string",
  "subtitle": "string",
  "text": "string",
  "responses": [
    "string"
  ],
  "status": "string"
}

クエリAPI移行ガイドクエリAPI移行ガイド への直接リンク

Query APIに移行するクライアントは、以下の例を参照して、従来のレポートエンドポイントの動作を再現できます。

各例について:

  • :accountID、:campaignID、または:creativeIDを適切な値に置き換えます。
  • startDate、endDate、currency、およびtimezoneVariationを必要に応じて調整します。
  • 使用可能なメトリックとディメンションの定義については、/helpエンドポイントを使用してください。
アカウントキャンペーンブレークダウン

従来: GET /reporting/accounts/{accountId}/campaigns/breakdown
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": [
      "impressions", "referrals", "gross_cost", "click_thru_acquisitions",
      "click_thru_acquisitions_by_conversion_time", "unique_creatives",
      "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"
    ],
    "dimensions": ["campaign_id", "campaign_name"]
}
アカウントサマリー - 広告主

従来: GET /reporting/accounts/{accountId}/summary
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": []
}

アカウントサマリー - パートナー

従来: GET /reporting/accounts/{accountId}/summary
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions
{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"],
    "dimensions": []
}
アカウントトランザクション概要

従来: GET /reporting/accounts/{accountId}/transactions/overview
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"]
}
トランザクションブレークダウン

従来: GET /reporting/accounts/{accountId}/transactions/breakdown
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"],
    "dimensions": ["partner_id", "age_range", "gender", "page_type"]
}
キャンペーン概要

従来: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    }
}
キャンペーンブレークダウン

従来: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown
クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name", "audience_id", "campaign_country", "partner_sub_vertical"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    }
}
キャンペーンヒストグラム

従来: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram クエリAPI代替:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    },
    "interval": "day"
}
クリエイティブ概要

従来: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId} Query API Replacement:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"],
        "creative_id": [":creativeID"]
    }
}
Creative Breakdown

Legacy: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown Query API Replacement:

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns
{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name", "audience_id", "campaign_country", "partner_sub_vertical"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"],
        "creative_id": [":creativeID"]
    }
}

現在サポートされていないエンドポイント現在サポートされていないエンドポイント への直接リンク

以下のエンドポイントはQuery APIではまだサポートされていません。さらなる通知があるまで、引き続きこれらを使用してください：

  • GET /metadata/accounts/{accountId}/campaigns/{campaignId}
    ➤ キャンペーンメタデータ

  • GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
    ➤ オーディエンスメタデータ

  • GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
    ➤ クリエイティブメタデータ

この記事は役に立ちましたか？
Last updated Aug 4, 2026