メインコンテンツへスキップ
POST
新しいクローラーを開始
完了時に通知を受け取る: クロールが完了したときにHTTP POSTを受け取るために、webhookパラメータとあなたのエンドポイントURLを渡してください。詳細はWebhooksを参照してください。
結果の保持: このクロールの保存ファイルをデフォルトの7日間より長く保持するために、storage.expires_inを渡してください。値は7d、10d、30d、60d、90d、180d、365d、またはneverです。詳細はStorageを参照してください。

承認

Authorization
string
header
必須

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

ボディ

application/json
start_url
string
必須

クローラーの開始地点。

max_pages
number
必須

クロールするページの最大数。ウェブサイト全体をクロールするようなほとんどのユースケースに推奨されます。

storage
object

このクローラーの保存されたファイル(クロールされたページ)がどのくらいの期間保持されるかを制御します。省略された場合、7日間保持されます。実際の値はレスポンスでstorage.expires_inとして返されます。詳細は機能ドキュメントのストレージセクションを参照してください。無効な値は400を返し、コードはinvalid_storage_expires_inです。

include_urls
string[]

クロールに含めるURLパスパターンをglob構文で指定します。 デフォルトは/**で、すべてのURLを含みます。特定のセクションをクロールするには/blog/**のようなパターンを使用します(例:ブログページのみ)、/products/*.htmlは商品ページ用、または異なるセクション用に複数のパターンを使用します。*(任意の文字)や**(再帰的マッチング)などの標準的なglob機能をサポートしています。

exclude_urls
string[]

除外するglobパターンのURLパス名。例:/careers/**。除外されたURLは含まれるURLより優先されます。

max_depth
number

クロールの最大深度。n次のリンクまでのみ抽出するのに便利です。

include_external
boolean

外部リンクの一度目のクロール。

include_subdomain
boolean

ウェブサイトのサブドメインを含める。デフォルトはfalseです。

search_query
string

特定のリンクを見つけるためのオプションの検索クエリで、結果を関連性でソートすることもできます。

top_n
number

検索クエリに従って、各ページで最も関連性の高いリンクのトップNのみをクロールするためのオプションの数。

webhook
string<uri>

クロールが完了したときにPOSTリクエストを受け取るためのHTTPS URL。http://またはhttps://プロトコルを使用して公開アクセス可能なURLでなければなりません。localhostやプライベートIPアドレスを指すことはできません。ペイロード形式とリトライ動作についてはWebhooksを参照してください。

timeout
number

指定されたタイムアウトから約10秒余分にかかることがありますが、n秒後にクロールを終了し、その時点までに完了したページを取得します。

follow_robots_txt
boolean
デフォルト:true

robots.txtルールを尊重するかどうか。falseに設定すると、クローラーはrobots.txtの禁止指令に関係なくウェブサイトをスクレイプします。デフォルトはtrueです。

scrape_options
object

各個別ページのスクレイプがOlostep APIからリクエストする内容を制御します。すべてのフィールドはオプションです。

レスポンス

クロールが正常に開始されました。

storage
object

このクロールの保存されたファイルに適用された保持。

id
string

クロールID

object
string

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

status
string

in_progress または completed

created
number

エポックでの作成時間

start_date
string

日付での作成時間

start_url
string
max_pages
number
max_depth
number
exclude_urls
string[]
include_urls
string[]
include_external
boolean
search_query
string
top_n
number
current_depth
number

クロールプロセスの現在の深さ。

pages_count
number

クロールされたページの数

webhook
string
follow_robots_txt
boolean
credits_consumed
integer | null

このリクエストで消費されたクレジットの数。実行完了後に入力されるよ。クレジットは請求の根拠だよ。

cost_usd
number | null

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