Vai alla navigazione

Crea job di crawling

Crea un job di crawling per analizzare l’URL indicato con limiti di profondità e pagine specificati.

Header

xi-api-keystringOpzionale

Richiesta

This endpoint expects an object.
urlstringObbligatorio

URL di una pagina della documentazione a cui l'agente avrà accesso per interagire con gli utenti.

max_pagesintegerOpzionale1-10000Predefinito a 1000

Numero massimo di pagine da sottoporre a crawl (1-10.000); il valore predefinito è 1000.

patternstring or nullOpzionale<=2048 characters
Se impostato, vengono inclusi solo gli URL che corrispondono a questo pattern.
sitemap_urlslist of strings or nullOpzionale

Elenco di URL da sottoporre a crawl dalla sitemap (facoltativo, sostituisce il rilevamento automatico degli URL).

parent_folder_idstring or nullOpzionale
Se impostato, il documento o la cartella creati verranno inseriti nella cartella specificata.
enable_auto_syncbooleanOpzionalePredefinito a false
Indica se abilitare la sincronizzazione automatica per questo documento URL.
auto_removebooleanOpzionalePredefinito a false

Indica se rimuovere automaticamente il documento quando l'URL non è più disponibile. Applicabile solo quando la sincronizzazione automatica è abilitata.

auto_discoverbooleanOpzionalePredefinito a false

Durante la sincronizzazione automatica, rileva e aggiunge automaticamente le nuove pagine collegate alle pagine già sottoposte a crawl. Richiede enable_auto_sync=true.

minimum_frequency_daysinteger or nullOpzionale1-180

Frequenza minima (in giorni) con cui vengono aggiornati i documenti idonei sottostanti. L'intervallo effettivo può essere più breve, ma mai più lungo. Il valore predefinito è 7 e viene ridotto alla frequenza della cartella principale, se più restrittiva. Applicabile solo quando la sincronizzazione automatica è abilitata.

max_depthintegerOpzionalePredefinito a 3Deprecated

Deprecato: questo campo non ha effetto e verrà rimosso in una versione futura.

Risposta

Risposta riuscita
idstring
typeenumPredefinito a discovery
Valori consentiti:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOpzionale
I segmenti del path della cartella che portano alla cartella root, dalla root alla cartella padre.

Errori

422
Unprocessable Entity Error