Pendo Aggregation
PendoのAggregation APIは、Pendoデータにアクセスして処理するためのクエリ言語です。このAPIを使用すると、収集されたイベントデータに対して、MongoDBに似たクエリ言語を使用して構造化されたデータを取得できます。
Aggregation APIは、Pendo UI上で見れるデータをほぼすべて取得できます(一部制限あり）。PendoアプリもバックエンドではAggregation APIを利用しています。
Aggregation API
https://engageapi.pendo.io/#7c8479b8-3843-403c-94a9-04cbdf542db9
私は日々お客様にAggreagation クエリを提供したり、Pendo社内のデータを取得加工するのに利用しています。
Aggregation APIを実行する上で結構重要なポイントは、イベントソースからほしいフィールドだけに絞ってクエリを実行することです。
フィールドを絞らずにクエリを実行すると処理に時間がかかり応答がなかなか返ってきません。
５分を超える処理実行はタイムアウトしてキャンセルされてしまうこともあります。
(瞬時に数十万のレコード返せるすごい処理能力を要しているのでそんな滅多なことではタイムアウトしませんが）
処理時間が短いに越したことはないので、select句を使ってほしいフィールドだけに絞って実行を心がけています。
さぁ、ここで問題発生。
各ソースのフィールドってドキュメント化されていないんです。
あえてドキュメント化されていないようなんですが、これだと毎回selectなしで一回クエリ実行してほしいフィールドを確認してからクエリを書き直すという作業が発生します。
どこかにまとめておけばいいけど、毎回そのファイル見に行くのもめんどくさい。
できればIDE(Vscode)を離れずにドキュメントを参照できるようにしたい。
そこでVscode拡張を作ってしまえということで作りました。
注意：よく使用されるフィールドだけ抽出しています。完璧なリストはではない点ご留意ください。足りない項目あればGithubまでご連絡ください。
機能：
- vscodeコマンドagglookup: showでソースをクイック参照
- ファイルないにかかれているソース名をマウスホバーでフィールドのクイック参照
スクショ
ストアに公開していないので、ご自身でビルドして、インストールする必要がありますが、よろしければ使ってみてください！
追記：
インストール用のvsixファイルを作りました。
githubのリリースにあげています。install vsixからインストールしてご利用ください