APIの過去の実行履歴(リクエスト回数)を確認・出力する方法
「楽楽販売」の画面上でAPIのリクエスト回数を直接確認したり、統計データとして出力したりすることはできません
APIの実行回数(リクエスト数)を日時別や日付別に自動でカウントして表示する専用のダッシュボードや、ご契約プランの利用上限に対する現在の稼働率を直接確認できる画面はありません。
また、APIのリクエスト数のみを抽出して統計レポートとして一括出力する機能も備わっていない仕様です。
これは、システムの処理負荷を抑え、リアルタイムなデータ連携の正確性を保つための仕組みとして、ログの蓄積と統計表示を切り離して管理しているためです。
そのため、ユーザーがAPIの稼働状況や上限との乖離状況を把握するためには、お手数をおかけしますが、システムが記録している「操作ログ」をCSV形式で出力し、お客様ご自身で集計作業を行っていただく必要があります。
APIの実行回数を効率的に集計して稼働状況を把握するための代替案
直接的な確認機能はありませんが、管理者設定の「ログ一覧」にはAPIを介した操作もすべて記録されています。
このデータを活用して、現場でのリクエスト数を算出する具体的な手順をご案内します。
管理者設定の「ログ一覧」でAPI関連の操作に絞り込んで検索し、出力したCSVファイルをExcelのピボットテーブル等で集計して日時別の実行回数を算出する
APIの実行状況を正確に把握するために、以下の手順で操作ログの抽出と集計を行ってください。
1. 必要な権限の確認
操作ログを閲覧・出力するためには、対象のユーザーに「ログ閲覧」および「ログ出力」の権限が付与されている必要があります。権限がない場合は、管理者に設定の変更を依頼してください。
2. 操作ログの検索と絞り込み
【設定箇所】 管理者設定>メンテナンス機能>ログ一覧
1. 「操作日時」にて、確認したい期間を指定します。※一度に検索できる期間は最長で3か月分までです。
2. 「操作」の項目にて、以下のAPIに関連する操作を選択して検索を実行します。
・APIによるレコード登録/更新/削除/参照
・APIによるIP認証エラー(接続拒否の状況を確認したい場合)
※特定のデータベースに対するAPI実行数を知りたい場合は、「DB・フォルダ名」に対象のデータベース名を入力してください。
3. CSVデータの出力とExcelでの集計
1. 検索結果が表示されたら、画面右上の「CSV出力」ボタンをクリックし、ログデータをダウンロードします。
2. ダウンロードしたCSVファイルをExcelで開き、挿入タブの「ピボットテーブル」を活用します。
3. 行ラベルに「操作日時(日付や時間単位でグループ化)」、値に「ID」や「操作」を配置することで、1分間あたり、または1日あたりのリクエスト回数を可視化できます。これにより、プランの上限値(例:スタンダードプランなら1分間20リクエスト)に対して、どの程度の余裕があるか、あるいはどの時間帯に負荷が集中しているかを具体的に把握することが可能です。
操作ログの仕様確認とマニュアル
操作ログに記録される内容の詳細や、ログの保存期間の設定については、下記記事をご確認ください。
操作ログの検索手順や記録される操作内容の詳細を確認する
ログ一覧で確認できる「いつ・誰が・どこで・何をしたか」の情報の見方や、CSV出力の方法について詳しく解説しています。
ログ一覧
操作ログの保存期間や詳細情報の保存設定を変更する
ログがどのくらいの期間システムに保持されるかの設定方法です。集計に必要な期間のログが消えないよう、事前に設定状況を確認してください。
全体詳細設定
お問い合わせフォームよりご要望をお寄せください。
「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。
現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。
(記事ID:2932)
「API連携オプションがうまくいかない」の関連記事一覧
こちらの記事もあわせてご確認ください。
- CSVエクスポートAPIでメニューの複雑な絞り込み条件(複数設定)を適用してデータを取得することは可能か
- APIでインポート対象のデータベース(DB)を切り替える際の設定・確認手順
- レコード登録APIの実行時に従属項目の自動取得と任意値の指定を併用する方法・代替案
- APIで明細行を更新する際に行数が減っても余分な行が削除されない事象の解決策
- 外部システムからCSVエクスポートAPIを利用してデータ連携を行う方法・設定手順
- API連携オプション:エラー「内部エラーが発生しました。」と表示された
- API連携オプション:その他のエラー
- API連携オプション:エラー「アクセスが拒否されました。」と表示された
- API連携オプション:エラー「認証エラーです。」と表示された