Vai al contenuto principale
GET
/
v1
/
crawls
/
{crawl_id}
Recupera informazioni sul crawl
curl --request GET \
  --url https://api.olostep.com/v1/crawls/{crawl_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "created": 123,
  "start_date": "<string>",
  "start_url": "<string>",
  "max_pages": 123,
  "max_depth": 123,
  "exclude_urls": [
    "<string>"
  ],
  "include_urls": [
    "<string>"
  ],
  "include_external": true,
  "search_query": "<string>",
  "top_n": 123,
  "current_depth": 123,
  "pages_count": 123,
  "webhook": "<string>",
  "follow_robots_txt": true
}

​
Informazioni sul Crawl

Questo endpoint ti permette di ottenere informazioni dettagliate su un crawl specifico utilizzando il suo crawl_id.

​
Richiesta HTTP

GET /v1/crawls/{crawl_id}

​
Parametri

  • crawl_id (stringa, obbligatorio): L’identificatore unico del crawl di cui vuoi ottenere informazioni.

​
Risposta

Una risposta di successo restituirà un oggetto JSON contenente i dettagli del crawl.

​
Esempio di Risposta

{
  "id": "12345",
  "status": "completato",
  "created_at": "2023-10-01T12:00:00Z",
  "completed_at": "2023-10-01T12:30:00Z",
  "results": {
    "pages_crawled": 100,
    "errors": 5
  }
}

​
Codici di Stato

  • 200 OK: La richiesta è stata completata con successo.
  • 404 Not Found: Il crawl_id specificato non esiste.
  • 500 Internal Server Error: Si è verificato un errore sul server.

​
Esempio di Utilizzo

Ecco un esempio di come puoi utilizzare questo endpoint con curl: 
curl -X GET "https://api.olostep.com/v1/crawls/12345" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Assicurati di sostituire YOUR_ACCESS_TOKEN con il tuo token di accesso valido.

Autorizzazioni

​
Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

​
crawl_id
string
obbligatorio

L'ID del crawl per cui recuperare le informazioni.

Risposta

Risposta riuscita con informazioni sul crawl.

​
id
string

ID del Crawl

​
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 crawl.

​
pages_count
number

Conteggio delle pagine scansionate

​
webhook
string
​
follow_robots_txt
boolean