Get job details
Purpose
Retrieve detailed information about a specific matching job, including its current status, progress, and results.
Request data
HTTP method: GET
- Constants and parameters enclosed in curly brackets
{}must be replaced with their values. - See the following Request parameters section with the required and optional parameters tables for these values.
URL format
get
URL format
https://api.tomtom.com/maps/orbis/platform/gem/jobs/{job_id}
URL example
get
URL example
https://api.tomtom.com/maps/orbis/platform/gem/jobs/123456789
curl command example
get
curl command example
1curl -X GET "https://api.tomtom.com/maps/orbis/platform/gem/jobs/123456789" \2 -H "tomtom-api-key: YOUR_API_KEY" \3 -H "Authorization: Bearer YOUR_AUTH_TOKEN"
Request headers
| Header | Required | Description |
|---|---|---|
tomtom-api-key | Yes | Your TomTom API key |
Authorization | Yes | Bearer token from Azure CLI |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | string | Yes | The unique identifier of the job |
Response data
Response example (successful job)
1{2 "job_type": "ROAD_MATCHING",3 "overture_release": "2026-01-21.0",4 "input_filename": "test_data.parquet",5 "job_id": 123456789,6 "requested_at": "2026-02-18T10:38:59.031762Z",7 "result_filename": "test_data.results.parquet",8 "status": "SUCCESS",9 "storage_id": "storage-001",10 "statistics": {11 "confidence_threshold": 60,12 "execution_time_sec" : 9751,13 "kms_processed": 80208.39,14 "num_roads_processed": 397613,15 "roads_fully_matched_ratio": 0.675,16 "roads_matched_ratio": 0.8468,17 "roads_partially_matched_ratio": 0.1718,18 "roads_unmatched_ratio": 0.153119 }20}
Response example (running job)
1{2 "job_type": "ROAD_MATCHING",3 "overture_release": "2026-01-21.0",4 "input_filename": "test_data.parquet",5 "job_id": 123456789,6 "requested_at": "2026-02-18T10:38:59.031762Z",7 "result_filename": null,8 "status": "IN_PROGRESS",9 "storage_id": "storage-001",10 "statistics": null11}
Response fields
| Field | Type | Description |
|---|---|---|
job_id | integer | Unique identifier for the job |
storage_id | string | Storage where files are located |
input_filename | string | Name of the input file |
result_filename | string | Name of output file (when finished) |
job_type | string | Type of matching performed |
overture_release | string | Overture Maps release version used for ROAD_MATCHING jobs |
orbis_version | string | Orbis Map version used for LANE_LEVEL_MATCHING jobs |
status | string | Current job status |
requested_at | string | ISO 8601 timestamp of job creation |
statistics | object | Matching statistics (when finished) |
statistics.confidence_threshold | integer | Confidence threshold |
statistics.execution_time_sec | float | Execution time (seconds) |
statistics.kms_processed | float | Amount of processed kilometers |
statistics.num_roads_processed | integer | Amount of processed roads |
statistics.roads_fully_matched_ratio | float | Ratio of fully matched roads |
statistics.roads_matched_ratio | float | Ratio of matched roads |
statistics.roads_partially_matched_ratio | float | Ratio of partially matched roads |
statistics.roads_unmatched_ratio | float | Ratio of unmatched roads |
Job status values
| Status | Description |
|---|---|
REQUESTED | Job was requested and is waiting to be processed |
IN_PROGRESS | Job has started and is currently being executed |
FAILED | Job encountered an error during the execution |
SUCCESS | Job finished successfully |
Error responses
| HTTP Status | Error | Cause | Solution |
|---|---|---|---|
| 401 | Unauthorized | Invalid credentials | Refresh API key or token |
| 404 | Not Found | Job not found | Verify job ID |
| 500 | Internal Server Error | Server-side issue | Retry the request |