Crea Mappa - Olostep Docs

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

{ "id": "map_abc123", "urls_count": 22, "urls": [ "https://docs.olostep.com/api-reference/batches/create", "https://docs.olostep.com/api-reference/batches/info", "https://docs.olostep.com/api-reference/batches/items" ] }

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

Autorizzazioni

Authorization

string

header

obbligatorio

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

Corpo

application/json

url

string<uri>

obbligatorio

L'URL del sito web per il quale vuoi i link

search_query

string

Una query di ricerca opzionale per ordinare i link per rilevanza di ricerca.

top_n

number

Un numero opzionale per limitare solo ai primi n link per una query di ricerca.

include_subdomain

boolean

Includi i sottodomini dell'URL dato. true di default.

include_urls

string[]

Modelli di percorso URL da includere usando la sintassi glob. Per esempio: /blog/** per includere solo URL del blog. Verranno restituiti solo gli URL che corrispondono a questi modelli.

exclude_urls

string[]

Modelli di percorso URL da escludere usando la sintassi glob. Per esempio: /careers/**. Gli URL esclusi prevalgono sugli URL inclusi.

cursor

string

OPZIONALE: Cursore di paginazione da una risposta precedente. Quando fornito, restituisce il prossimo set di URL da dove la richiesta precedente si era fermata a causa del limite di dimensione della risposta.

Risposta

Risposta positiva con gli URL trovati sulla pagina

urls_count

integer

obbligatorio

Numero di URL nella risposta corrente

urls

string[]

obbligatorio

Array di URL trovati sulla pagina

string

Identificatore univoco per questa mappa

cursor

string

Cursore di paginazione per recuperare il prossimo set di URL limitato a causa del limite di dimensione di 10MB. Se nullo o non presente, tutti gli URL sono stati recuperati.

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 piano tariffario — 99% accurato, ma credits_consumed è il valore autorevole.