メインコンテンツへスキップ
公開されたダッシュボードやノートに含まれるチャートについて、数値の取得、サーバーでの集計、画像の取得を行います。

2 つの手順

1. チャートの名前を確認する

ダッシュボードまたはノートの id を指定して、fetch を実行します。結果の metadata.charts に、チャートごとの名前(name)、集計方法(values)、フィルタ(filters)が含まれます。
<id> は、検索結果に表示された id に置き換えます。実行結果は、ダッシュボード Sales Orders Dashboard(id は pQ9rS0tU1v)で実行したものです。長い出力は省略しています。 実行結果
metadata.charts にチャートの name が表示されていれば、チャートの名前を確認できています。

2. 数値を取得する

確認した name を --chart に指定して、chart get-data を実行します。
<id> はダッシュボードなどの id、<chart> はチャートの name に置き換えます。実行結果は、ダッシュボード(id は pQ9rS0tU1v)のチャート qR0sT1uV(Monthly Sales Trend)のものです。長い出力は省略しています。 実行結果
rows に数値が、chart.encoding に各軸の列と集計方法が表示されます。context には、公開時点、データの時点、パラメーターの値が含まれます。数値は、公開されたときの値です。 has_more が true の場合は、続きがあります。取得済みの行数を --offset に指定すると、続きを取得できます。1 回の呼び出しで取得できる行数は、最大 100 行です。
rows に先頭 5 行が表示されていれば、数値を取得できています。

集計する(任意)

合計、順位付け、条件に合う行の抽出が必要な場合は、chart query を使用します。指定方法は dataset query と同じです。
<id> と <chart> は、ダッシュボードなどの id とチャートの name に置き換えます。列の名前は、chart get-data の結果の query.columns で確認します。実行結果は、チャートが kL8mN9oP(Sales by Region)のものです。上位 3 つの地域は、チャートの先頭の 3 行と一致します。 実行結果
集計の対象は、チャートが公開時に集計した表です。すでに平均、重複を除いた件数、比率などで集計された列をさらに合計または平均すると、警告 CHART_REAGGREGATION が表示されます。その場合は、警告を添えて結果を伝えるか、result.excluded_totals を使用します。 result.has_more が true の場合は、結果に含まれていない行があります。続きを取得する指定はないため、条件を絞り込むか、集計します。上の結果の警告 RESULT_TRUNCATED は、この状態を示しています。
rows に集計結果が表示されていれば、集計できています。

チャートの形を確認する(任意)

チャートの傾向や配置を確認する場合は、画像を取得します。
出力の形を示す例で、値は説明用です。チャートは qR0sT1uV(Monthly Sales Trend)です。image_path(画像の保存先)の行は省略しているので、次の JSON は抜粋で、完全な JSON ではありません。 実行結果
画像は、公開したときに保存されたもので、データより古い場合があります。result.image.may_be_stale で確認します。画像は expl を実行しているコンピューターに保存され、保存先は image_path に表示されます。--output で保存先を指定することもできます。正確な数値は、画像ではなく chart get-data で取得します。
result.image に画像の情報が表示されていれば、取得できています。

トラブルシューティング

すべてのフラグはchart get-data、集計の指定方法はchart query、画像の取得はchart get-imageで説明しています。