Jobs
API information
The job resource is managed by the Jobs API.
XPKit Portal
You can view a list of the most recent jobs and check on their status.
Service URLs
| Region | URL |
|---|---|
| AMER | https://jobs.amer.xpkit.net |
| APAC | https://jobs.apac.xpkit.net |
| China | https://jobs.china.xpkit.cn |
| EMEA | https://jobs.emea.xpkit.net |
OpenAPI Specification
| Resource name | Documentation | Download |
|---|---|---|
| Job | View | Link |
Example job
{
"job_id": "717edbde-b911-49aa-9240-f7e2f6e9d21b",
"status": "Succeeded",
"result": {
"info": "Export task finished successfully. File ready for download.",
"number_of_records": 849
},
"xpkit_service": "Exports API",
"created": "2022-03-01T14:55:12Z",
"last_modified": "2022-03-01T14:56:32Z"
}
Notes on jobs
- Jobs are deleted 7 days after they have completed. Any issued job IDs will be invalid after this time.
- The responses may contain personal data such as email addresses so if you are storing these anywhere outside of XPKit be aware of this.
- The status field can be one of the following:
- Queued - job is in queue and waiting to be processed
- Running - job is now running
- Succeeded - job succeeded
- Failed - job failed
- Cancelled - job was cancelled and didn't complete
- Some services such as the Notifications API, retry failed jobs automatically on your behalf. These jobs will appear in Running state and a result.error key will be available containing information on why the task hasn't yet completed. Once all retries have been attempted, if the job still hasn't completed successfully it will enter Failed state.