メインコンテンツへスキップ
GET
/
v1
/
batches
/
{batch_id}
バッチ情報を取得
curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "created": 123,
  "total_urls": 123,
  "completed_urls": 123,
  "parser": "<string>",
  "country": "<string>",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "processed": "true"
  },
  "webhook": "<string>"
}
カスタムデータを添付: 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文字、すべての値は文字列として保存されます。

:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
webhook
string

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