例

応答例

メッセージのトラフィックに関する構造化データを提供する メトリクスAPIからの応答 例を下記に示します。この応答には、チャネル固有のメトリクス、タイムスタンプ、配信ステータスやエンゲージメントの詳細など、コミュニケーションのパフォーマンス状況を明確に把握できるようにする様々な情報が含まれています。

JSONの表示

json

{
  "requestId": "D1ABDD934260284DAE68550826DACDF3",
  "status": "SUCCESS",
  "response": {
    "requestedPeriod": {
      "sentSince": "2024-04-04T00:00:00Z",
      "sentUntil": "2024-04-05T23:59:59Z"
    },
    "totalRows": 6,
    "columns": [
      { "columnName": "CHANNEL_CODE", "columnDataType": "STRING" },
      { "columnName": "HOUR", "columnDataType": "DATE_TIME" },
      { "columnName": "STATUS_GROUP", "columnDataType": "STRING" },
      { "columnName": "STATUS", "columnDataType": "STRING" },
      { "columnName": "COMMUNICATION", "columnDataType": "INTEGER" },
      { "columnName": "TOTAL_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "DELIVERED_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "FAILED_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "TOTAL_SENT_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "TOTAL_RECEIVED_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "TRAFFIC_DELIVERY_RATE", "columnDataType": "NUMBER" },
      { "columnName": "SEEN_OPENED_TRAFFIC_COUNT", "columnDataType": "INTEGER" },
      { "columnName": "TRAFFIC_SEEN_OPEN_RATE", "columnDataType": "NUMBER" }
    ],
    "rows": [
      [
        "SMS", "2024-04-04T13:00:00.000+0000", "DELIVERED", "DELIVERED_TO_HANDSET",
        200000022475266, 1, 1, 0, 1, 0, 1.0, "N/A", "N/A"
      ],
      [
        "EMAIL", "2024-04-05T11:00:00.000+0000", "REJECTED", "REJECTED_VALIDATION_FAILED",
        "N/A", 3, 0, 3, 3, 0, 0.0, 0, 0.0
      ],
      [
        "EMAIL", "2024-04-05T12:00:00.000+0000", "UNDELIVERABLE", "UNDELIVERABLE_REJECTED_OPERATOR",
        200000023016143, 1, 0, 1, 0, 0, 0.0, 0, 0.0
      ],
      [
        "EMAIL", "2024-04-05T12:00:00.000+0000", "DELIVERED", "DELIVERED_TO_HANDSET",
        "N/A", 1, 1, 0, 1, 0, 1.0, 0, 0.0
      ],
      [
        "EMAIL", "2024-04-05T12:00:00.000+0000", "REJECTED", "REJECTED_VALIDATION_FAILED",
        "N/A", 1, 0, 1, 1, 0, 0.0, 0, 0.0
      ],
      [
        "ZALOZNS", "2024-04-04T13:00:00.000+0000", "UNDELIVERABLE", "UNDELIVERABLE_REJECTED_OPERATOR",
        200000022475266, 1, 0, 1, 1, "N/A", 0.0, "N/A", "N/A"
      ]
    ]
  }
}

JSON構造は、次の3つの主要なキーを持つ最上位のオブジェクトで構成されます。

requestId：リクエストを一意に識別します。
status：リクエストが成功したかどうかを示します。
response：クエリによって返される実際のデータが含まれます。

responseオブジェクト内には、重要な情報がいくつか含まれています。

requestedPeriod：リクエストで求められるデータの対象期間を指定するパラメーターで、通常は開始タイムスタンプと終了タイムスタンプで表されます。
totalRows：応答で返される行の合計数を示すパラメーターです。
columns：各列の名前やデータ型など、データの構造に関する情報を提供する配列です。
rows：クエリによって返される実際のデータを含む配列です。各行は1 つの通信インスタンスを表し、値は columns 配列で指定された列に対応します。

この例では、6行のデータがあり、それぞれが通信イベントを表します。データには、チャネルコード、タイムスタンプ、ステータスグループ、ステータス、通信数、トラフィック数、配信率、開封率などの詳細情報が含まれます。一部の値はデータが使用できないことを示す N/A と表示されることがあります。

メッセージのカウント数の合計

このクエリでは、過去1日の間に送信されたSMSメッセージの合計を1時間ごとに集計した結果が得られます。このデータは、メッセージトラフィックの傾向の概要を把握し、配信のパフォーマンスと失敗率を分析するのに役立ちます。

リクエスト本文の見本

JSONの表示

結果の見本

この応答は、リクエストで指定された期間の SMSメッセージトラフィック の概要を示しています。このサマリーには、メッセージ総数、正常に配信されたメッセージ数、失敗したメッセージ数といった詳細情報が含まれています。

JSONの表示

結果の内訳

次の表には、特定のタイムスタンプの SMSトラフィックの詳細 を示す応答データがまとめられています。

メトリクス	値
`CHANNEL_CODE`	SMS
`HOUR` (時間)	2024-03-19T11:00:00.000Z
`TOTAL_TRAFFIC_COUNT`	17
`TOTAL_SENT_TRAFFIC_COUNT`	17
`DELIVERED_TRAFFIC_COUNT`	16
`FAILED_TRAFFIC_COUNT`	1

アプリケーションIDとエンティティIDによるアグリゲーション

このクエリは、アプリケーションID と エンティティID でグループ化されたメッセージトラフィックデータを取得し、様々なアプリケーションやブランド間のトラフィック分布を分析できるようにします。このクエリを通じて得られた情報は、キャンペーン、通知や各通信チャネルでのコミュニケーションのパフォーマンスを計測するのに役立ちます。

リクエスト本文の見本

下記のリクエストでは、指定した時間範囲内に送信されたメッセージをフィルター処理し、アプリケーションID とエンティティID でデータを集計することを求めています。応答には、トラフィック総数、送信メッセージ数、配信メッセージ数、配信率 などの主要なメトリクスが含まれます。

JSONの表示

結果の見本

応答は、アプリケーションIDとエンティティIDごとに集計データを返し、様々なブランドや通信チャネル間でのメッセージの分布を示します。

JSONの表示

結果の内訳

次の表は、アプリケーションID と エンティティID に基づいて集計されたメッセージトラフィック をまとめたもので、複数のブランドとチャネルで取り扱ったメッセージ総数、送信メッセージ数、配信数、配信率がメトリクスとして含まれています。

`CHANNEL_CODE`	SMS	SMS	SMS	SMS	VIBER	VIBER	WHATSAPP
`APPLICATION_ID`	プロモーション	プロモーション	通知	通知	プロモーション	プロモーション	プロモーション
`ENTITY_ID`	ブランドA	ブランドB	ブランドA	ブランドB	ブランドA	ブランドB	ブランドB
`TOTAL_TRAFFIC_COUNT`	250	500	100	420	200	350	800
`TOTAL_SENT_TRAFFIC_COUNT`	230	480	91	390	191	299	499
`>DELIVERED_TRAFFIC_COUNT`	210	430	85	370	180	280	450
`TRAFFIC_DELIVERY_RATE` (%)	91.30	89.58	93.41	94.87	94.24	93.65	90.28

Voice and Video のメトリックとフィルタアナライズ