Naar hoofdinhoud gaan
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" ] }

Autorisaties

​
Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waarbij jouw auth token is.

Body

application/json
​
url
string<uri>
vereist

De URL van de website waarvoor je de links wilt

​
search_query
string

Een optionele zoekopdracht om de links te sorteren op zoekrelevantie.

​
top_n
number

Een optioneel aantal om alleen de top n links voor een zoekopdracht te beperken.

​
include_subdomain
boolean

Inclusief subdomeinen van de gegeven URL. true standaard.

​
include_urls
string[]

URL-padpatronen om op te nemen met behulp van glob-syntaxis. Bijvoorbeeld: /blog/** om alleen blog-URLs op te nemen. Alleen URLs die aan deze patronen voldoen, worden geretourneerd.

​
exclude_urls
string[]

URL-padpatronen om uit te sluiten met behulp van glob-syntaxis. Bijvoorbeeld: /careers/**. Uitgesloten URLs hebben voorrang op opgenomen URLs.

​
cursor
string

OPTIONEEL: Paginering cursor van een vorige respons. Wanneer verstrekt, retourneert het de volgende set URLs vanaf waar het vorige verzoek stopte vanwege de responsgrootte limiet.

Respons

Succesvolle respons met URLs gevonden op de pagina

​
urls_count
integer
vereist

Aantal URLs in de huidige respons

​
urls
string[]
vereist

Array van URLs gevonden op de pagina

​
id
string

Unieke identificatie voor deze kaart

​
cursor
string

Paginatiecursor om de volgende set URLs op te halen die beperkt zijn vanwege de 10MB grootte limiet. Als deze null is of niet aanwezig, zijn alle URLs opgehaald.