LISTEN API

LISTEN APIは、GraphQLの仕様を理解している開発者向けの試験的なAPIです。一部の用途では、専用のREST APIも提供します。

エンドポイント

POST https://listen.style/graphql

リクエスト本文はJSONで、queryと必要に応じてvariablesを指定します。

query {
  __typename
}

curl https://listen.style/graphql \
  -H 'Content-Type: application/json' \
  --data '{"query":"query { __typename }"}'

API仕様の確認

現在利用できるQuery、Mutation、型、引数、Enum、null許容性は、GraphQLのイントロスペクションを使って確認してください。イントロスペクションに対応したGraphQLクライアントでは、スキーマの参照、補完、入力内容の検証を行えます。

GraphQLスキーマを現在のAPI仕様の正とします。個々のQueryやMutationの利用方法について、LISTENからのサポートは提供していません。

利用上の注意

• APIのスキーマや挙動は、予告なく変更される場合があります。変更へ追従できる用途で利用してください。
• Mutationには、データの変更や削除、非同期処理を開始するものがあります。戻り値とerrorsを確認してください。
• 認可条件、回数制限、対応形式などは変更される場合があり、公開互換性の保証対象ではありません。
• エラーメッセージの文言には依存しないでください。

認証が必要な操作については、認証を参照してください。

プレミアムゴールド以上で利用できるCSV出力については、アクセス解析エクスポートを参照してください。