Skip to main content

GraphQLエンドポイント

すべてのGraphQLクエリは単一のエンドポイントに送信されます:
POSTGETの両方のメソッドがサポートされています。
本番ワークロードにはPOSTを使用してください。GETリクエストはURLにクエリをエンコードするため、長さ制限があり複雑なクエリには不向きです。

認証

X-API-KEYヘッダーにAPIキーを渡して認証します。REST Data APIと同じAPIキーを使用します — 別途の認証情報は不要です。
ChainStream DashboardApplicationsCreate New App でAPIキーを取得できます。キーは cs_live_... で始まります。

必須ヘッダー


リクエスト形式

GraphQLリクエストボディは2つのフィールドを持つJSONオブジェクトです:

POSTの例

GETの例


対応ネットワーク

Cubeクエリを適切なChain Groupで囲んでネットワークを選択します:

レスポンス形式

すべてのレスポンスは以下の構造のJSONです:
extensions.creditsフィールドはクレジットが消費された場合に含まれます。クレジットの計算方法の詳細は課金とクレジットをご覧ください。

エラーレスポンス

クエリが不正な場合や失敗した場合、レスポンスにはerrors配列が含まれます:
アプリケーションに統合する前に、GraphQL IDEを使用してクエリをインタラクティブに検証してください。IDEは自動補完とインラインエラーハイライトを提供します。

次のステップ

最初のクエリを実行

IDEまたはcURLからステップバイステップのチュートリアルに従って実際のクエリを実行します。

スキーマを探索

25のCube、フィールドタイプ、フィルタリングオペレータ、集計関数を詳しく見ます。