Understanding Map Results

After a successful mapping request, the Map API returns a structured response containing the discovered URLs and information about the mapping operation.

Understanding this response helps you decide which URLs to extract, crawl, or process further.

Response Structure

A successful response contains the following top-level fields.

Example Response

{
  "success": true,
  "links": [
    {
      "url": "https://docs.geonode.com",
      "source": "sitemap"
    },
    {
      "url": "https://docs.geonode.com/docs/api-reference",
      "source": "sitemap"
    }
  ],
  "metadata": {
    "url": "https://geonode.com/",
    "duration_ms": 0,
    "links_count": 202
  }
}

Response Fields

Understanding success

The success field indicates whether the request completed successfully.

{
  "success": true
}

A value of true means the Map API successfully processed the request and returned a response.

Understanding links

The links array contains every URL discovered during the mapping process.

Each item contains:

Example:

{
  "url": "https://docs.geonode.com/docs/api-reference",
  "source": "sitemap"
}

The source field helps you understand where each URL originated.

Possible values include:

Understanding metadata

The metadata object provides information about the mapping request itself.

{
  "metadata": {
    "url": "https://geonode.com/",
    "duration_ms": 0,
    "links_count": 202
  }
}

This information can be useful for monitoring request performance and understanding the size of the mapping result.

Understanding warning

The warning field is optional.

It appears when the request succeeds but there is additional information that may help you improve the results.

For example:

{
  "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."
}

In this example:

• The request completed successfully.
• No matching URLs were found.
• The warning suggests mapping the base domain instead of a sub-path.

Empty Results

Sometimes a successful request may not return any discovered URLs.

Example:

{
  "success": true,
  "links": [],
  "metadata": {
    "links_count": 0
  }
}

This usually means:

• No URLs matched the request.
• The search filter did not match any discovered URLs.
• The mapped location did not contain discoverable pages.

What Can You Do with the Results?

Once you've received the response, you can use the discovered URLs in several ways.

Typical next steps include:

• Extract structured content from selected pages.
• Crawl larger sections of the website.
• Export the discovered URLs for reporting or analysis.
• Store the URLs for future processing.

Best Practices

• Always check the success field before processing the response.
• Handle an empty links array as a valid response.
• Review the warning field when it is present.
• Use links_count to understand the size of the mapping result.
• Use the source field to understand how each URL was discovered.

Next Steps

Now that you understand the Map response, continue to Map Best Practices to learn recommended approaches for building efficient URL discovery workflows.