Saltar al contenido principal
POST
/
v1
/
maps
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" ] }

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer del formato Bearer , donde es tu token de autenticación.

Cuerpo

application/json
​
url
string<uri>
requerido

La URL del sitio web para el cual quieres los enlaces

​
search_query
string

Una consulta de búsqueda opcional para ordenar los enlaces por relevancia de búsqueda.

​
top_n
number

Un número opcional para limitar solo a los n enlaces principales para una consulta de búsqueda.

​
include_subdomain
boolean

Incluir subdominios de la URL dada. true por defecto.

​
include_urls
string[]

Patrones de ruta de URL para incluir usando sintaxis glob. Por ejemplo: /blog/** para incluir solo URLs de blogs. Solo se devolverán URLs que coincidan con estos patrones.

​
exclude_urls
string[]

Patrones de ruta de URL para excluir usando sintaxis glob. Por ejemplo: /careers/**. Las URLs excluidas tendrán prioridad sobre las URLs incluidas.

​
cursor
string

OPCIONAL: Cursor de paginación de una respuesta anterior. Cuando se proporciona, devuelve el siguiente conjunto de URLs desde donde la solicitud anterior se detuvo debido al límite de tamaño de respuesta.

Respuesta

Respuesta exitosa con URLs encontradas en la página

​
urls_count
integer
requerido

Número de URLs en la respuesta actual

​
urls
string[]
requerido

Array de URLs encontradas en la página

​
id
string

Identificador único para este mapa

​
cursor
string

Cursor de paginación para recuperar el siguiente conjunto de URLs limitado debido al límite de tamaño de 10MB. Si es nulo o no está presente, se han recuperado todas las URLs.