GET Async Batch Job Details enterprise only
Note
This is a synchronous call that retrieves detailed information about a specific batch job.
The batch job details service allows you to retrieve comprehensive information about a specific batch geocoding job, including status, timestamps, record counts, and result URLs.
Resource URL
Resource Information
Response Formats | JSON |
Authentication | Yes (Requires Key) |
Rate Limited | Yes |
Request Parameters
Request Parameter | Description | Required |
---|---|---|
key | The API Key, which is needed to make requests to MapQuest services. | Yes |
Note: The jobId
is specified in the URL path, not as a query parameter.
Response Object
id | The unique job identifier |
status | The current job status |
href | The MapQuest URL of the job details |
created | ISO timestamp when the job was created |
started | ISO timestamp when the job was started |
ended | ISO timestamp when the job ended |
records | Record counts for the job |
records.total | Total number of records in the job |
records.valid | Number of valid records |
records.invalid | Number of invalid records |
records.processed | Number of processed records |
records.pending | Number of pending records |
records.succeeded | Number of succeeded records |
records.failed | Number of failed records |
resultsHref | URL to retrieve job results (empty if not available) |
errorsHref | URL to retrieve job errors (empty if no errors) |
outputType | The output format type for the job (currently only "csv" is supported) |
Example Request
bash
curl -X GET "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789?key=YOUR_API_KEY"
Example Response
json
{
"id": "abc123-def456-ghi789",
"status": "completed",
"href": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789",
"created": "2025-09-07T22:17:15.870404Z",
"started": "2025-09-07T22:18:03.829643Z",
"ended": "2025-09-07T22:18:12.557219Z",
"records": {
"total": 3,
"valid": 3,
"invalid": 0,
"processed": 3,
"pending": 0,
"succeeded": 3,
"failed": 0
},
"resultsHref": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789/results",
"errorsHref": "",
"outputType": "csv"
}
Job Status Values
Status | Description |
---|---|
submitted | Job has been received and submitted |
queued | Job is queued and waiting to be processed |
pending | Job is pending processing |
inProgress | Job is currently being processed |
completed | Job has finished processing successfully |
stopped | Job has been stopped |
failure | Job failed due to an error |
Important Notes
- Blocking Call: This is a synchronous request that returns immediately with current job status
- Authentication: Same API key as other endpoints, passed as query parameter
- Job ID: The job ID is passed in the URL path, not as a query parameter
- Timestamps: All timestamps are in ISO 8601 format with UTC timezone
- Record Counts: Use the
records
object to track processing progress - Result URLs: Use
resultsHref
to retrieve results when job is completed - Error Handling: Check
errorsHref
for error details if the job failed