Skip to main content
GET
バッチ情報を取得
カスタムデータを添付: metadata パラメーターを使用して、バッチにキーと値のペアを保存します。詳細はメタデータを参照してください。

承認

Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

パスパラメータ

batch_id
string
必須

情報を取得するバッチのID。

レスポンス

バッチ情報を含む成功したレスポンス。

id
string

バッチ ID

object
string

オブジェクトの種類。このエンドポイントでは "batch" だよ。

status
string

in_progress または completed

created
number

作成されたエポック

total_urls
number

バッチ内のURLの数

completed_urls
number

完了したURLの数

parser
string
country
string
metadata
object

オブジェクトに関する追加情報を保存するためのキーと値のペアのセット。Stripeのアプローチに従い、検証ルールがあります:最大50キー、キーは最大40文字(角括弧なし)、値は最大500文字、すべての値は文字列として保存されます。

:
webhook
string

完了通知を受け取るためのWebhook URL

credits_consumed
integer | null

このリクエストで消費されたクレジットの数。実行完了後に設定されるよ。クレジットは請求の基準だよ。

cost_usd
number | null

このリクエストのUSDでの推定コスト。実行完了後に設定されるよ。消費されたクレジットとプランのレートから計算されるよ — 99%の精度だけど、credits_consumedが正確な値だよ。