データのクエリ

メトリック API は、サービス全体のトラフィックに関連するデータをクエリおよび取得するための簡単な方法を提供します。システムにシームレスに統合して、アクティビティのさまざまな側面に関する洞察を得ることができます。

非同期分析クエリ

クエリを送信する

メトリクスAPIにPOST要求を送信する必要があります。この API は、要求をバックグラウンドで処理するように NTT CPaaS に指示します。クエリの送信が成功すると、API は 201 状態と、後の手順でクエリを参照するために使用する requestID を返します。

{
  "callbackUrl": "{https://example.com/receive}",
  "request": {
    "filterBy": {
      "accountKeys": [
        "{AccountKeys}"
      ],
      "sentSince": "2024-04-01T00:00:00.000+0000",
      "sentUntil": "2024-04-01T01:00:00.000+0000",
      "includeSubaccounts": true,
      "directions": [
        "OUTBOUND"
      ],
      "channelCodes": [
        "SMS"
      ]
    },
    "aggregateBy": [
      "ACCOUNT_KEY",
      "HOUR",
      "DIRECTION",
      "STATUS"
    ],
    "metrics": [
      "TOTAL_TRAFFIC_COUNT",
      "DELIVERED_TRAFFIC_COUNT"
    ]
  }
}

要求にコールバック URL パラメーターを指定して (callbackUrl パラメーターを使用)、処理されたクエリ結果を配信する場所を決定し、ワークフローを合理化できます。

クエリの状態を取得する

メトリック API に GET 要求を送信して、クエリの状態を要求します。POST呼び出しが返した要求 ID を指定する必要があります。

curl -L -g 'https://{baseUrl}/metrics/1/requests/{requestId}' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

要求本文

このセクションでは、クエリの JSON 要求本文で使用できる各パラメーターについて説明します。クエリで使用できる指標とディメンションの詳細については、「指標とフィルター」を参照してください。

制約

レガシ アカウント

メトリクスAPIは、従来のアカウント設定では使用できない場合があります。この機能へのアクセスに問題がある場合は、サポート (opens in a new tab)にお問い合わせください。

時間範囲のクエリ

メトリック API を使用すると、さまざまな時間粒度で集計データを取得できます。使用可能な粒状化と、要求された日数範囲に基づくその制約は次のとおりです。

許可された顆粒化:

• HOUR
• 日
• WEEK_SUNDAY
• WEEK_MONDAY
• WEEK_SATURDAY
• MONTH (月)
• 四半期
• 年

要求された日数の範囲によっては、すべての粒状化が許可されるわけではありません。制約の概要は次のとおりです。