Vai al contenuto principale
POST
Avvia un nuovo crawl
Ricevi una notifica al completamento: Passa il parametro webhook con l’URL del tuo endpoint per ricevere un HTTP POST quando il crawl è completato. Vedi Webhooks per i dettagli.
Conservazione dei risultati: Passa storage.expires_in per mantenere i file memorizzati di questo crawl più a lungo rispetto al valore predefinito di 7 giorni. Valori: 7d, 10d, 30d, 60d, 90d, 180d, 365d, o never. Vedi Storage per i dettagli.

Autorizzazioni

Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer del tipo Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
start_url
string
obbligatorio

Il punto di partenza del crawl.

max_pages
number
obbligatorio

Numero massimo di pagine da scansionare. Consigliato per la maggior parte dei casi d'uso come la scansione di un intero sito web.

storage
object

Controlla per quanto tempo i file memorizzati di questo crawl (le sue pagine scansionate) vengono conservati. Se omesso, vengono mantenuti per 7 giorni. Il valore effettivo viene restituito nella risposta come storage.expires_in. Vedi la sezione Storage nei documenti delle funzionalità. Un valore non valido restituisce 400 con codice invalid_storage_expires_in.

include_urls
string[]

Modelli di percorso URL da includere nel crawl usando la sintassi glob. Di default è /** che include tutti gli URL. Usa modelli come /blog/** per scansionare sezioni specifiche (ad esempio, solo pagine del blog), /products/*.html per le pagine dei prodotti, o modelli multipli per sezioni diverse. Supporta le funzionalità standard glob come * (qualsiasi carattere) e ** (corrispondenza ricorsiva).

exclude_urls
string[]

Nomi di percorso URL in modello glob da escludere. Ad esempio: /careers/**. Gli URL esclusi prevarranno sugli URL inclusi.

max_depth
number

Profondità massima del crawl. Utile per estrarre solo fino a n-grado di link.

include_external
boolean

Scansiona i link esterni di primo grado.

include_subdomain
boolean

Includi i sottodomini del sito web. false di default.

search_query
string

Una query di ricerca opzionale per trovare link specifici e anche ordinare i risultati per rilevanza.

top_n
number

Un numero opzionale per scansionare solo i primi N link più rilevanti su ogni pagina secondo la query di ricerca.

webhook
string<uri>

URL HTTPS per ricevere una richiesta POST quando il crawl è completato. Deve essere un URL pubblicamente accessibile usando il protocollo http:// o https://. Non può puntare a localhost o indirizzi IP privati. Vedi Webhooks per il formato del payload e il comportamento di retry.

timeout
number

Termina il crawl dopo n secondi con le pagine completate fino a quel momento. Potrebbe richiedere ~10s extra rispetto al timeout fornito.

follow_robots_txt
boolean
predefinito:true

Se rispettare le regole di robots.txt. Se impostato su false, il crawler scansionerà il sito web indipendentemente dalle direttive di disallow di robots.txt. true di default.

scrape_options
object

Controlla cosa richiede ogni singola pagina scansionata dall'API di Olostep. Tutti i campi sono opzionali.

Risposta

Crawl avviato con successo.

storage
object

Conservazione applicata ai file memorizzati di questa scansione.

id
string

ID della scansione

object
string

Il tipo di oggetto. "crawl" per questo endpoint.

status
string

in_progress o completed

created
number

Tempo di creazione in epoch

start_date
string

Tempo di creazione in data

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

La profondità attuale del processo di scansione.

pages_count
number

Conteggio delle pagine scansionate

webhook
string
follow_robots_txt
boolean
credits_consumed
integer | null

Numero di crediti consumati da questa richiesta. Popolato dopo il completamento dell'esecuzione. I crediti sono la fonte di verità per la fatturazione.

cost_usd
number | null

Costo stimato in USD per questa richiesta. Popolato dopo il completamento dell'esecuzione. Calcolato dai crediti consumati e dal tuo tasso di piano — 99% accurato, ma credits_consumed è il valore autorevole.