Configuring Map Requests

The Map API provides several optional request parameters that let you control how URLs are discovered and returned.

This guide explains when to use each option and how it affects the mapping results.

Request Parameters

The Map endpoint accepts the following parameters.

Field	Required	Description
`url`	Yes	The website to map.
`search`	No	Returns only discovered URLs that contain the specified text.
`include_subdomains`	No	Includes URLs from supported subdomains during discovery. Default: `true`.
`ignore_query_parameters`	No	Removes query parameters when normalizing discovered URLs. Default: `true`.

Basic Request

The minimum request only requires the website URL.

{
  "url": "https://geonode.com"
}

Filter Results with `search`

Use the search parameter to return only URLs containing a specific keyword.

{
  "url": "https://geonode.com",
  "search": "docs"
}

The search performs a case-insensitive substring match against the discovered URLs.

For example, searching for:

docs

may return URLs such as:

https://docs.geonode.com
https://docs.geonode.com/docs/api-reference

If no URLs match your search term, the request still succeeds.

Example response:

{
  "success": true,
  "links": [],
  "metadata": {
    "url": "https://geonode.com/",
    "duration_ms": 4208,
    "links_count": 0
  },
  "warning": "No results found. If you targeted a sub-path, try mapping the base domain for broader coverage."
}

An empty links array does not indicate an error. It simply means that no discovered URLs matched the search value.

Include Subdomains

By default, the Map API includes supported subdomains during discovery.

You can control this behavior using include_subdomains.

{
  "url": "https://geonode.com",
  "include_subdomains": true
}

Set the value to false if you only want to map the primary domain.

{
  "url": "https://geonode.com",
  "include_subdomains": false
}

Use this option when:

Discovering documentation hosted on subdomains.
Mapping an organization's entire website.
Limiting discovery to the primary domain only.

Ignore Query Parameters

Many websites generate multiple URLs that differ only by query parameters.

For example:

/products?page=1
/products?page=2
/products?sort=newest

When ignore_query_parameters is enabled, the Map API normalizes these URLs to reduce duplicates.

{
  "url": "https://geonode.com",
  "ignore_query_parameters": true
}

Disable this option if query parameters represent unique pages that you want to keep.

{
  "url": "https://geonode.com",
  "ignore_query_parameters": false
}

Combining Parameters

You can combine multiple options in the same request.

{
  "url": "https://geonode.com",
  "search": "docs",
  "include_subdomains": true,
  "ignore_query_parameters": true
}

Best Practices

Always provide the base website URL.
Use search to reduce the number of returned URLs.
Enable include_subdomains when mapping websites that host content across multiple subdomains.
Leave ignore_query_parameters enabled unless query parameters represent unique content.
Combine parameters to return only the URLs that are relevant to your application.

Next Steps

Now that you know how to configure mapping requests, continue to Understanding Map Results to learn how to interpret the response returned by the Map API.

Configuring Map Requests

On this page