コンテンツにスキップ

GraphQL アナリティクス API

GraphQL アナリティクス API は、Cloudflare のネットワークを通過する HTTP リクエストに関するデータや、Firewall や Load Balancing などの特定の製品からのデータを提供します。ネットワークアナリティクスのユーザーは、パケットレベルのデータにもアクセスできます。GraphQL アナリティクス API を使用して、特定のデータセットや関心のあるメトリクスを選択し、さまざまな次元に沿ってデータをフィルタリングおよび集約し、結果を他のアプリケーションと統合します。

API の基盤は、Facebook によって作成されオープンソース化された GraphQL フレームワーク です。GraphQL には活発な開発者コミュニティがあり、クエリを実行するための強力なクライアントがあるため、簡単に始めることができます。GraphQL は特に視覚化の構築に役立ち、Cloudflare ダッシュボードのアナリティクスを支えています。

GraphQL はビジネスドメインをスキーマを使用してグラフとしてモデル化します。スキーマ内には、異なるタイプのノードとその接続(エッジ)の論理的定義があります。これらのノードは、アナリティクスに使用するデータセットです。GraphQL では、SQL のようにクエリを記述します:データセット(テーブル)、取得するメトリクス(リクエストやバイトなど)、および次元によるフィルタリングやグループ化(例えば、期間)を指定します。

GraphQL は従来の API とは異なり、単一のエンドポイントを持っています:

https://api.cloudflare.com/client/v4/graphql

クエリパラメータは、POST リクエストのペイロード内の JSON オブジェクトとして渡します。

curl を使用して GraphQL アナリティクス API にリクエストを送信できます。あるいは、GraphQL クライアントを使用してクエリを構築し、GraphQL アナリティクス API にリクエストを送信することもできます。

クライアント

私たちは、例として GraphiQL を使用しています。オンラインで見つけることができる他の多くの人気のあるオープンソースクライアント、例えば AltairInsomnia もあります。