Map

Retrieving Map Jobs

After creating a mapping job, you can retrieve it later instead of creating a new request.

The Map API provides two endpoints for this:

  • GET /v1/map/jobs — List your previous mapping jobs.
  • GET /v1/map/{job_id} — Retrieve the complete details of a specific mapping job.

These endpoints are useful for reviewing previous jobs, recovering after an application restart, and accessing discovered URLs.


Retrieval Workflow

The following diagram shows how both endpoints work together.


When to Use Each Endpoint

EndpointUse Case
GET /v1/map/jobsView all of your previous mapping jobs.
GET /v1/map/{job_id}Retrieve the complete details of one mapping job.

List Previous Mapping Jobs

Retrieve a paginated list of your mapping jobs.

GET /v1/map/jobs

A successful response contains a list of jobs together with pagination information.

Each job includes:

FieldDescription
job_idUnique identifier of the mapping job.
urlWebsite that was mapped.
statusCurrent job status.
links_countNumber of discovered URLs.
duration_msTime required to complete the job.
searchSearch filter used when the job was created, if any.
error_codeError code if the job failed. Otherwise null.
created_atTime when the job started.
completed_atTime when the job finished.

The response also includes:

FieldDescription
pageCurrent page number.
page_sizeNumber of jobs returned per page.
page_countTotal number of available pages.

Finding the Right Job

Most applications identify a job by checking:

  • The website URL.
  • The job status.
  • The creation time.
  • The optional search filter.

Retrieve a Specific Mapping Job

Once you have a job_id, retrieve the complete job information.

GET /v1/map/{job_id}

This endpoint returns:

  • Job information.
  • Mapping configuration.
  • Statistics.
  • Every discovered URL.

Understanding the Response

A completed mapping job contains several sections.

Job Information

These fields describe the mapping job itself.

FieldDescription
job_idUnique job identifier.
urlWebsite that was mapped.
statusCurrent status of the mapping job.
created_atTime when the job was created.
completed_atTime when the job completed.

Mapping Configuration

These values show how the mapping job was executed.

FieldDescription
searchSearch filter applied during URL discovery.
include_subdomainsIndicates whether subdomains were included.
ignore_query_parametersIndicates whether query parameters were ignored when discovering URLs.

Statistics

The response also includes useful information about the completed job.

FieldDescription
links_countTotal number of discovered URLs.
duration_msTime taken to complete the mapping job.
tokens_chargedNumber of API tokens charged for the request.

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

Each entry contains:

FieldDescription
urlThe discovered page URL.
sourceWhere the URL was discovered (html or sitemap).

Example:

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

Recovering Previous Jobs

If your application loses the original job_id, you don't need to create another mapping request.

Instead:

  1. Call GET /v1/map/jobs.
  2. Find the required job.
  3. Copy its job_id.
  4. Retrieve the complete results with GET /v1/map/{job_id}.

This approach helps avoid creating duplicate mapping jobs.


Best Practices

  • Save the returned job_id whenever you create a mapping job.
  • Use GET /v1/map/jobs to locate previous jobs if the identifier is unavailable.
  • Check the job status before using its results.
  • Review links_count to understand how many URLs were discovered.
  • Reuse completed mapping jobs whenever possible instead of creating duplicate requests.

Next Steps

Now that you know how to retrieve previous mapping jobs and inspect their results, continue to Best Practices to learn recommendations for building efficient and reliable mapping workflows.

On this page