複数アカウントコントロールプレーンAPI用のコンバージョンAPIゲートウェイ: リファレンス

時間フレーム別のアカウントイベント指標を取得する

管理者がアカウントを管理する権限を持っている場合に、ピクセルでのアカウント特有のイベント指標とイベントレベルを取得します。

スキーマ

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
  tenantQueries(tenantId: $tenantId) {
    eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
      activity {
        name
        receivedCount
        publishedCount
        lastUpdated
      }
      incoming {
        eventNamesCount
        eventsCount
      }
      outgoing {
        eventNamesCount
        eventsCount
        publishSuccessRate
      }
    }
  }
}
_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
pixelIds: [String!]
_______________________________________________________________________________________________________      
timeWindow: Int

フィールド

フィールド説明

フィールド	説明
`tenantId` ID	必須アカウントのユニークID
`pixelIds` String	任意イベント指標取得対象のピクセルIDのリスト
`timeWindow` Int	任意分単位の期間(デフォルト値は60分)

tenantId
ID

必須

アカウントのユニークID

pixelIds
String

任意

イベント指標取得対象のピクセルIDのリスト

timeWindow
Int

任意

分単位の期間(デフォルト値は60分)

戻り値

EventMetricsSnapshot

フィールド	説明
`id` ID	EventMetricsSnapshotのID -- 常にEventTrafficSummary:incoming
`incoming` EventTrafficSummary	受信イベント概要データ
`outgoing` ConversionsApiPublishSummary	送信イベントデータ
`activity` EventActivity	イベントアクティビティのリスト
`domainActivity` DomainActivity	ドメインアクティビティのリスト

エラーコード

コード	説明
401	イベント指標を見る権限がない
500	内部サーバーエラー

リクエストの例

クエリ

query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
 tenantQueries(tenantId: $tenantId) {
   eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
     activity {
       name
       receivedCount
       publishedCount
       lastUpdated
     }
     incoming {
       eventNamesCount
       eventsCount
     }
     outgoing {
       eventNamesCount
       eventsCount
       publishSuccessRate
     }
   }
 }
}

変数

{
 "tenantId": "IaoreXfj",
 "pixelIds": ["18904456377094531"]
}

応答の例

{
   "data": {
       "tenantQueries": {
           "eventMetrics": {
               "activity": [
                   {
                       "name": "Purchase_PN_Mar22_Events",
                       "receivedCount": 4,
                       "publishedCount": 0,
                       "lastUpdated": "1678753252000"
                   }
               ],
               "incoming": {
                   "eventNamesCount": 1,
                   "eventsCount": 4
               },
               "outgoing": {
                   "eventNamesCount": 0,
                   "eventsCount": 0,
                   "publishSuccessRate": 0.0
               }
           }
       }
   }
}