Zum Hauptinhalt springen
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"
  ]
}

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Body

application/json
​
url
string<uri>
erforderlich

Die URL der Website, für die du die Links möchtest

​
search_query
string

Eine optionale Suchanfrage, um die Links nach Suchrelevanz zu sortieren.

​
top_n
number

Eine optionale Zahl, um die Ergebnisse auf die obersten n Links für eine Suchanfrage zu begrenzen.

​
include_subdomain
boolean

Subdomains der angegebenen URL einbeziehen. Standardmäßig true.

​
include_urls
string[]

URL-Pfadmuster, die mit Glob-Syntax einbezogen werden sollen. Zum Beispiel: /blog/**, um nur Blog-URLs einzubeziehen. Es werden nur URLs zurückgegeben, die diesen Mustern entsprechen.

​
exclude_urls
string[]

URL-Pfadmuster, die mit Glob-Syntax ausgeschlossen werden sollen. Zum Beispiel: /careers/**. Ausgeschlossene URLs haben Vorrang vor einbezogenen URLs.

​
cursor
string

OPTIONAL: Paginierungscursor aus einer vorherigen Antwort. Wenn angegeben, werden die nächsten URLs abgerufen, wo die vorherige Anfrage aufgrund der Größenbeschränkung der Antwort aufgehört hat.

Antwort

Erfolgreiche Antwort mit URLs, die auf der Seite gefunden wurden

​
urls_count
integer
erforderlich

Anzahl der URLs in der aktuellen Antwort

​
urls
string[]
erforderlich

Array von URLs, die auf der Seite gefunden wurden

​
id
string

Eindeutiger Bezeichner für diese Karte

​
cursor
string

Paginierungscursor, um den nächsten Satz von URLs abzurufen, der aufgrund des 10MB Größenlimits begrenzt ist. Wenn null oder nicht vorhanden, wurden alle URLs abgerufen.