Docs
ドキュメントを検索...⌘K

パラメータ

リクエストパラメータは、エンドポイントが返すデータを制限します。 すべてのリクエストパラメータ値はURLエンコードする必要があります

次のパラメータは、特別な構文の値を必要とします。 各エンドポイントに必要なパラメータと任意パラメータの完全な一覧については、APIリファレンスを参照してください。

選択

例: field_a,field_b,field_c

フィールド名をカンマ区切りで並べた必須リストです。 エンドポイントから返すフィールドを指定します。 すべてのエンドポイントがこのパラメータを受け付けるわけではありません。

有効なフィールド名の一覧は、APIリファレンスでエンドポイントのレスポンススキーマを参照してください。

where

例: {"and":[{"field":"field_a","is":["gt",90]},{"field":"field_b","is":["eq","SEO"]}]}

結果を絞り込むためのフィルター式です。 構文の詳細はフィルター構文で詳しく説明しています。 すべてのエンドポイントがこのパラメータを受け付けるわけではありません。

フィルター式で使用できる有効なフィールド名の一覧は、APIリファレンスの当該エンドポイントのパラメータ説明を参照してください。 これはselectパラメータのフィールド名一覧と異なる場合があります。

order_by

例: field_a:desc,field_b:asc

指定したフィールドと方向(descまたはasc)で結果を並べ替えます。 すべてのエンドポイントがこのパラメータを受け付けるわけではありません。

有効なフィールド名の一覧は、APIリファレンスでエンドポイントのレスポンススキーマを参照してください。 これはselectパラメータのフィールド名一覧と同じです。