Looker API v3.1 の fields パラメータの使い方

背景

Search Folders のレスポンスボディから必要な項目のみにフィルタしたかった。

前提

• バージョン： v3.1

認証

Looker APIを使ってLooker上で定義されたデータを取得するが分かりやすくまとめていたので、割愛。

内容

※ APIリファレンスには使い方への記載がないため、実際に使ってみての挙動

fieldsパラメータはカンマ区切りで記述することでフィルタできる。JSONのフィールドタイプがオブジェクト（配列含む）の場合は、項目名の後に()を記載し、中にカンマ区切りで項目名を記載する。以下、curlの場合のサンプル。

$ curl -i -H "Authorization: token {token}"  \
"https://{host}/api/3.1/folders/search?fields=name,id,looks(id,title),dashboards(id,title)"

[{"name":"name","id":1,"looks":[{"id": 1,"title":"title"}],"dashboards":[{"id": 2,"title":"title"}]}]