API利用状況ページをリリースしました

こんにちは、ケンオール開発チームです。

ダッシュボードに「API利用状況」ページを追加しました。ご自身のアカウントから送信されたAPIリクエストの数を、期間を選んで確認できます。

API利用状況ページ

これまで、お客様ご自身がリクエスト数を確認する手段をご用意できていませんでした。「先週のキャンペーンでどのくらいリクエストが増えたのか」「いま流れている量は普段どおりなのか」といった疑問にその場でお答えできるようにしたのが今回の機能です。

左のサイドバーに「API利用状況」という項目が増えていますので、そちらからご覧ください。

期間を選んで確認できますこの見出しへのリンク

画面上部のボタンで期間を切り替えられます。

日単位の期間では日別の棒グラフを、それより短い期間では推移を追いやすい折れ線グラフを表示します。下の画像は「過去1時間」を選んだところです。

過去1時間の利用状況

リリース直後の切り分けや、負荷試験中の様子を眺めるといった用途では、分単位の粒度が役に立つはずです。

過去の分もさかのぼって集計済みですので、公開初日から「過去60日」までご確認いただけます。「先月はどうだったか」を今日すぐに振り返れます。

なお、ここに出る数字は送信されたリクエストの数で、拒否されたリクエストも含みます。アプリケーション側で数えている成功回数とは一致しないことがありますので、その点はご留意ください。

グラフの右上にある「合計 / APIキー別」の切り替えで、リクエスト数をAPIキーごとに分解して表示できます。

APIキー別の内訳

日単位の期間では積み上げ棒グラフに、時間単位の期間ではキーごとの折れ線になります。凡例にはそれぞれのキーの合計リクエスト数を併記していますので、グラフの色を目で追わなくても内訳が読み取れます。

APIキー別の折れ線グラフ

用途ごとにAPIキーを分けて運用されている場合は、どの機能がどれだけAPIを呼んでいるかがそのまま見えます。想定より多いキーが見つかったら、そのキーを使っている箇所のキャッシュを見直す、といった形でお使いいただけます。

細かい点ですが、以下のような挙動になっています。

色はキーごとに固定されます。期間を切り替えても、引き続き表示されているキーの色は変わりません。
グラフに表示するのはリクエスト数の多い8キーまでです。9つ目以降は「その他」としてまとめて表示します。キーごとの正確な数値は、グラフの上にある表ですべてのキーについて確認できます。
期限切れ・削除済みのキーも、状態を添えて表に残ります。過去の期間を振り返ったときに、当時使っていたキーの分が消えてしまわないようにするためです。
「APIキー別」を表示している状態のURLはそのまま共有できます (?view=keys が付きます)。

ダッシュボードのホームにも、今日のリクエスト数と過去7日間のグラフを追加しました。ログインした直後に、普段どおりかどうかがひと目でわかります。

ホーム画面のAPI利用状況カード

「詳しい利用状況を見る」から、上でご紹介したページに移動できます。

集計には数分の遅れが生じる場合があります。直近の数分については、グラフの右端の値が実際より少なめに出ることがあります。

ご意見・ご要望がありましたら、お問い合わせよりお気軽にお寄せください。