公開
発行者使用量
期間内の公開 App 呼び出し: 合計と日・時間・App・チャネル等の内訳。
GET
発行者使用量
GET https://api-datahub.octoparse.com/v1/publisher/usage
認証:APIキー必須(Authorization: Bearer <API Key>)。
期間内に自分の App がどのように呼び出されたか:期間の合計に加え、日別(短い期間では時間別)・App 別・呼び出しチャネル別の内訳(任意の 2 つを掛け合わせ可)、または終端状態・バージョン・エラーコード別の診断用内訳。請求集計の発行者側の対応版で、語彙は同じ(created_from / created_to は実行の開始時刻基準で、開始を含み終了を含まない。tz_offset は日の境界を動かすだけ。data_app / triggered_by で範囲を絞る)。ただし所有の軸は「自分が開始した実行」から「自分が所有する App」(Release が 0 件の App を含む)に切り替わる。
日/時間/App/チャネル別の内訳は、終端状態に達した時点で集計される時間単位のバケットから得られるため、任意の期間と整時間のオフセットで正確かつ低コストに算出できる。状態/バージョン/エラー別の内訳は実行詳細からその都度計算されるため、開始・終了の両方の境界が必須で、期間は最大 92 日(400 range-too-wide)。エラーグループはエラーを持つ実行のみを対象とし、各グループには最新のエラーメッセージが sample_message として含まれる。作者のデバッグ実行は既定で除外され、プラットフォームのヘルスプローブは一切カウントされない。成功には部分成功を含む。キャンセルされた実行は成功率の分母に含めない。終端状態の実行がない指標は null。amount は呼び出し元がこれらの実行に支払ったデータ料金であり、発行者の確定収益ではない。
日/時間のグループは昇順(hour のキーは tz_offset におけるローカル時刻 YYYY-MM-DDTHH:00 で、タイムゾーンの接尾辞は付かない)。その他のグループは実行数の降順。data_app に不明な App や他人の App を指定すると 404 を返す。
totals.callers は期間内の呼び出し元ユーザーの重複なし数で、実行詳細から算出される。期間が限定されていて最大 92 日の場合にのみ設定される。group_by=caller は単一の private または shared App を呼び出し元別に分解する:作者(caller_kind=owner)と現在 grant リストにいるユーザー(grantee)は現在のユーザー名で表示され、それ以外(以前の grantee、公開期間中の呼び出し元)はすべて 1 つの other グループにまとめられる。公開 App や複数 App では 400 caller-group-unavailable を返す:公開 App の呼び出し元は匿名のままで、件数のみがカウントされる。
リクエスト
クエリパラメータ
string
デフォルト:"day"
1 つまたは 2 つの次元をカンマ区切りで指定:
day / hour / data_app / triggered_by / state / version / error / caller(例:day,data_app)。day と hour は組み合わせられない。state / version / error / caller には最大 92 日の限定された期間が必要。caller はさらに private または shared の App をちょうど 1 つ指定する必要がある。既定は day。string[]
これらの App に限定する(
<username>/<app_name>、繰り返し指定可)。既定:自分のすべての App。string
開始(この時刻を含む)。
string
終了(この時刻を含まない)。
integer
デフォルト:"0"
日/時間バケットのタイムゾーンオフセット(分)。中国標準時には
480 を使う。バケットは時間単位のため、30 分単位のオフセットは時間に丸められる。範囲は -720〜840。string
1 つの呼び出しチャネルに限定する(
api / sdk / mcp / web など)。boolean
デフォルト:"False"
作者のデバッグ実行を含めるかどうか。
boolean
デフォルト:"False"
created_from の直前にある同じ長さの期間について previous_totals も返す。開始・終了の両方の境界が必要。リクエスト例
レスポンス
200 成功
data に包まれます。フィールド:
object
必須
実際に使われた範囲とオフセット。
string
通貨。
object
必須
期間の合計。
object
compare=true のときの、直前の同じ長さの期間の合計。string
実際に使われた次元。
object[]
グループ行。各行は
totals と同じ指標に加え、次元キー(day / hour / namespace + app_name / channel / state / version / error_code + error_category + sample_message + last_seen_at / username + caller_kind)を持つ。使われないキーは null。エラー
エラー応答は
{"error": {code, category, message, retryable}} です。エラー を参照。