- DarkLight
Check Job Status
- DarkLight
Overview
This API allows you to fetch the status of a specific job using its unique Job ID. It helps track the progress or outcome of a submitted job efficiently.
Endpoint URL
The API endpoint where you send data is:
/cxs/job/{jobId}
HTTP Method
The method to be used for the request:
GET
Sample Response
{
"jobId": "777b971f-ad84-4d15-ae4e-578f4b562469",
"status": "Completed",
"successCount": 10,
"failureCount": 2,
"createdDate": "2024-11-14T08:47:44.309822100Z",
"completedDate": "2024-11-14T08:47:54.309822100Z",
"failedEvents": [
{
"profileId": "59701e01-4c82-4254-8a9f-07e3ad8f635e",
"event": "{'itemId':null,'itemType':'event','scope':null,'version':null,'objectType':null,'systemMetadata':null,'eventType':'mergeProfiles','sessionId':null,'profileId':null,'timeStamp':null,'properties':{'FirstName':'Eugena','LastName':'Luce','Mobile':'7812706500','Home':'7812706500','Office':'7812706500','LastModifiedDate':'2024-04-16T07:35:21.000+0000','Email':'eluce@pacificretail.com','LeadId':'00QGB00001td5gl2AA','Country':'USA'},'customObject':null,'toDeleteProfile':[],'toUpdateCustomObjects':[],'profileChanges':'NO_CHANGE','customObjectChanges':'NO_CHANGE','profileFieldChanges':[],'customObjectFieldChanges':[],'source':null,'target':null,'persistent':true,'attributes':{},'profile':null,'session':null,'actionPostExecutors':null}",
"error": ""
}
]
} Response Field Descriptions
This table outlines the response fields for the API request, including their types, whether they are, and their descriptions.
Field Name | Data Type | Description |
|---|---|---|
jobId | string | Unique identifier for each job request. |
status | string | Indicates the status of the job. Possible values:
|
successCount | integer | Total number of records successfully ingested. |
failureCount | integer | Total number of records that failed ingestion. |
createdDate | date | Date when the job was created. |
completedDate | date | Date when the job was completed. |
profileId | string | Displayed only when there are failed records. It contains the Profile IDs of the records that failed. Successful records are not included. |
event | string | Contains event details in string format. This includes the entire message received for the failed record, which is sent back for troubleshooting. |
error | string | Provides details about the error encountered during processing . Here is an example: ERROR ElasticsearchException[Elasticsearch exception [type=exception, reason=java.lang.IllegalArgumentException: java.lang.IllegalArgumentException: unable to parse date [2020-02-18T13:42:54Z]]]; |
Error Response
The following table outlines the error responses for the API with descriptions.
Error Response | Description |
|---|---|
401 – Unauthorized | Indicates that the authentication token provided is either invalid or has expired. |
404 – Jobid Not Found | Indicates that the specified job ID does not exist or cannot be located in the system. |
405 – Method not allowed | Indicates that the HTTP method used in the request is not allowed for the specified resource. |
429 - Too Many Requests | Indicates that the client has exceeded the allowed number of requests within a given time frame. |