Reports API のベストプラクティス

このページでは、Vonage Reports APIを効果的に使用するためのベストプラクティスをご紹介します。

フィルターによるリクエストの最適化

フィルタリングオプションを活用して、リクエストを調整します。利用可能な Reports API フィルタは、要求された製品によって異なります。詳細は同期メソッドのクエリ・パラメータそして非同期メソッドのリクエストボディ.

フィルタを使用することで、必要なデータのみを取得し、APIコールを最適化し、ユーザーのリクエストコストを削減することができます。

最もポピュラーなフィルターは

日付範囲によるフィルタリング (date_start, date_end)
フィルタリング id 正確なイベント（メッセージ/コールなど）の実際のステータスを取得する。
電話番号によるフィルタリング (to, fromなど)

メッセージ・ステータス監視のベスト・プラクティス

メッセージの最新ステータスをモニターするには id リクエストパラメータ - これは同期メソッドのみである。同じデータを何度もリクエストするよりもはるかに効率的な方法である。

すべてのサブアカウントでのリクエストの最適化

マスターアカウントとそのすべてのサブアカウントのレポートを要求する予定があり、サブアカウントの数が10以上である場合、より迅速にレポートを取得するために以下のフローを検討してください：

に電話する。サブアカウントAPI をクリックして、マスターアカウントIDに関連するすべてのサブアカウントの実際のリストを取得します。
各サブアカウントと、サブアカウントなしのマスターアカウントIDに対して、別々にReports APIを呼び出します。

価格とPay as You Go価格モデルを理解する

を持つ。 ペイ・アズ・ユー・ゴー 価格モデルでは、レポートのレコードごとに課金されます。参照このページをクリックして例をご覧ください。複数のレポートで同じCDRをリクエストすると、複数回請求されます。

一定期間に何枚のCDRを取得できるかを知るには、次のページに移動してください。ダッシュボードそして アナリティクス をクリックしてください。こうすることで、レポートの価格を見積もりやすくなります。

制限事項

非同期エンドポイント制限 - 現在、最大1GBのアーカイブ・レポートを作成できます。約7Mレコードです。製品にもよりますが、カラム数が少ないものはもっと多くなります。 1つのレポートのレコード数を減らすには、データを塊で取得するようにしてください。期間、ステータス、電話番号などでデータをフィルタリングできます。チェック価格設定詳細はこちら。
料金制限 - を意識すること。レートリミット.Reports APIは、非同期で使用される場合は毎秒5リクエスト、同期で使用される場合は毎秒10リクエストをサポートしています。これらの制限を超えると HTTP 429: Too Many Requests エラー。

同期方式と非同期方式の選択

データをより素早く小塊で取得したい場合は同期メソッドを使用します（シンク・エンドポイントから1000チャンクのデータを無制限に取得することが可能です）。

より大きなデータセット（10,000レコード以上）を取得する場合は非同期メソッドを使用します。同期方式は、ダッシュボードや内部ストレージ用にリアルタイムのデータを必要とするお客様に最適です。非同期方式の利点は、ユーザーがレポートをCSVファイルとして受け取ることができ、さらに手動で分析するために使用できることです。さらに、非同期レポートでは、1つのレポートですべてのサブアカウントのデータを取得できます。

APIの利用状況を効果的に監視する

APIの使用パターンを追跡するために内部モニタリングを実装するか、製品でReports APIを使用します。 REPORTS-USAGE への Reports API の使用状況に関する情報を取得します。.このアプリケーションは無料で、過去13ヶ月分のデータを入手することができます。これにより、潜在的な非効率性を特定し、アプリケーションを最適化し、計画された予算内に収めることができます。