はじめに
CircleCIの基本的なデータは、お客様管理画面(User Page)からOverviewやInsigntsタブを通して確認する事が出来ます。しかし、より細かくデータを取得/分析したい場合は、こちらのAPI機能を使っていただくのがオススメです！
この記事でわかる・できること
- Usage APIの使い方
- データの取得方法
この記事の対象者
- CircleCI 初心者
- データに興味がある方
- より深く数値を分析したい方
早速データを取得してみた！
1. まずは自分のOrganization IDを確認する
自社CircleCIのIDは以下のお客様管理画面(イメージ)から見る事が可能です。
2.ユーザー画面からAPI Tokensを発行する
CircleCIのUser Settings→Personal API Tokens→Create New Tokenをクリックします。
3.Usage APIのDocumentationからCreate a usage exportを参照する
画面右上のRequest Samplesをコピーしてurl,Token,data(取得したい日付)を編集します。ターミナルを起動して実行し、usage_export_job IDを取得します。
4.Get a usage exportからデータを取得する
同様に画面右上のSamplesをCopyし、url, usage_export_job IDとTokenを編集します。
5.抽出されたdownload_urlsの箇所をコピー
ブラウザに該当箇所をペーストする事で、PCへのダウンロードが自動で始まります。
6.ダウンロードされたデータを確認する
以下画像は一部ですが、ジョブ毎の細かな数値を取得する事が出来ます。
参考資料
おわりに・まとめ
いかがでしたでしょうか？私も初めて利用したのですが、短時間で様々なデータを取得する事が出来て、大変便利な機能だと思いました！日本のお客様にも数多くご利用いただいておりますし、他ツールと組み合わせる事でより高度な分析も可能です。Usage APIを活用して、CircleCIの利用率向上を目指していきましょう！
CircleCIについてもっと知りたい方は、こちらからお問い合わせいただけます。
また、すぐに使ってみたい方は無料サインアップもご利用いただけます。